From b471df6a935571ba263b374d92b8a7417ead703c Mon Sep 17 00:00:00 2001 From: Pearl Dsilva Date: Tue, 31 Dec 2024 11:26:26 -0500 Subject: [PATCH 1/2] Fix VM Usage histroy response --- cloudstack/SystemVMService.go | 29 +- cloudstack/VirtualMachineService.go | 31 +- cloudstack/cloudstack.go | 2 +- generate/generate.go | 3 + generate/listApis.json | 146614 ++++++++++---------- test/testdata/VirtualMachineService.json | 62 + 6 files changed, 73492 insertions(+), 73249 deletions(-) diff --git a/cloudstack/SystemVMService.go b/cloudstack/SystemVMService.go index 48f3b650..e878eaad 100644 --- a/cloudstack/SystemVMService.go +++ b/cloudstack/SystemVMService.go @@ -1085,12 +1085,29 @@ type ListSystemVmsUsageHistoryResponse struct { } type SystemVmsUsageHistory struct { - Displayname string `json:"displayname"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Stats []string `json:"stats"` + Displayname string `json:"displayname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Stats []SystemVmsUsageHistoryStats `json:"stats"` +} + +type SystemVmsUsageHistoryStats struct { + Cpuused string `json:"cpuused"` + Diskiopstotal int64 `json:"diskiopstotal"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Memoryintfreekbs int64 `json:"memoryintfreekbs"` + Memorykbs int64 `json:"memorykbs"` + Memorytargetkbs int64 `json:"memorytargetkbs"` + Networkkbsread int64 `json:"networkkbsread"` + Networkkbswrite int64 `json:"networkkbswrite"` + Networkread string `json:"networkread"` + Networkwrite string `json:"networkwrite"` + Timestamp string `json:"timestamp"` } type MigrateSystemVmParams struct { diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 22949eca..d2ec7b1d 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -10752,16 +10752,33 @@ func (s *VirtualMachineService) ListVirtualMachinesUsageHistory(p *ListVirtualMa type ListVirtualMachinesUsageHistoryResponse struct { Count int `json:"count"` - VirtualMachinesUsageHistory []*VirtualMachinesUsageHistory `json:"virtualmachinesusagehistory"` + VirtualMachinesUsageHistory []*VirtualMachinesUsageHistory `json:"virtualmachine"` } type VirtualMachinesUsageHistory struct { - Displayname string `json:"displayname"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Stats []string `json:"stats"` + Displayname string `json:"displayname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Stats []VirtualMachinesUsageHistoryStats `json:"stats"` +} + +type VirtualMachinesUsageHistoryStats struct { + Cpuused string `json:"cpuused"` + Diskiopstotal int64 `json:"diskiopstotal"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Memoryintfreekbs int64 `json:"memoryintfreekbs"` + Memorykbs int64 `json:"memorykbs"` + Memorytargetkbs int64 `json:"memorytargetkbs"` + Networkkbsread int64 `json:"networkkbsread"` + Networkkbswrite int64 `json:"networkkbswrite"` + Networkread string `json:"networkread"` + Networkwrite string `json:"networkwrite"` + Timestamp string `json:"timestamp"` } type ImportVmParams struct { diff --git a/cloudstack/cloudstack.go b/cloudstack/cloudstack.go index bae9bb31..68d27059 100644 --- a/cloudstack/cloudstack.go +++ b/cloudstack/cloudstack.go @@ -39,7 +39,7 @@ import ( "strings" "time" - gomock "go.uber.org/mock/gomock" + gomock "go.uber.org/mock/gomock" ) // UnlimitedResourceID is a special ID to define an unlimited resource diff --git a/generate/generate.go b/generate/generate.go index 1269bec9..9a8dd509 100644 --- a/generate/generate.go +++ b/generate/generate.go @@ -2014,6 +2014,9 @@ func (s *service) generateResponseType(a *API) { case "listSecondaryStorageSelectors": pn(" Count int `json:\"count\"`") pn(" %s []*%s `json:\"%s\"`", ln, parseSingular(ln), "heuristics") + case "listVirtualMachinesUsageHistory": + pn(" Count int `json:\"count\"`") + pn(" VirtualMachinesUsageHistory []*VirtualMachinesUsageHistory `json:\"virtualmachine\"`") case "listHostHAResources": pn(" Count int `json:\"count\"`") pn(" %s []*%s `json:\"%s\"`", ln, parseSingular(ln), "hostha") diff --git a/generate/listApis.json b/generate/listApis.json index 7bd79154..d672b210 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -5,6 +5,14 @@ "isasync": true, "name": "createVPCOffering", "params": [ + { + "description": "the ID of the service offering for the VPC router appliance", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" + }, { "description": "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, @@ -12,6 +20,14 @@ "required": false, "type": "map" }, + { + "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", + "length": 255, + "name": "internetprotocol", + "required": false, + "since": "4.17.0", + "type": "string" + }, { "description": "true if network offering is meant to be used for NSX, false otherwise.", "length": 255, @@ -38,34 +54,12 @@ "type": "list" }, { - "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "description": "true if network offering for NSX VPC offering supports Load balancer service.", "length": 255, - "name": "networkmode", + "name": "nsxsupportlb", "required": false, "since": "4.20.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", - "length": 255, - "name": "internetprotocol", - "required": false, - "since": "4.17.0", - "type": "string" - }, - { - "description": "the display text of the vpc offering, defaults to the 'name'", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "services supported by the vpc offering", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "type": "boolean" }, { "description": "set to true if the offering is to be enabled during creation. Default is false", @@ -84,25 +78,16 @@ "type": "boolean" }, { - "description": "the ID of the service offering for the VPC router appliance", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "true if network offering for NSX VPC offering supports Load balancer service.", + "description": "the name of the vpc offering", "length": 255, - "name": "nsxsupportlb", - "required": false, - "since": "4.20.0", - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", "length": 255, - "name": "routingmode", + "name": "networkmode", "required": false, "since": "4.20.0", "type": "string" @@ -116,33 +101,38 @@ "type": "map" }, { - "description": "the name of the vpc offering", + "description": "services supported by the vpc offering", "length": 255, - "name": "name", - "required": true, + "name": "supportedservices", + "required": false, + "type": "list" + }, + { + "description": "the display text of the vpc offering, defaults to the 'name'", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", + "length": 255, + "name": "routingmode", + "required": false, + "since": "4.20.0", "type": "string" } ], "related": "updateVPCOffering,listVPCOfferings", "response": [ { - "description": "true if vpc 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": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { @@ -151,71 +141,19 @@ "type": "integer" }, { - "description": "the id of the vpc offering", - "name": "id", - "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 zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, - { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" - }, { "description": "the internet protocol of the vpc offering", "name": "internetprotocol", "type": "string" }, - { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" - }, - { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the name of the vpc offering", - "name": "name", - "type": "string" - }, { "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", @@ -225,19 +163,19 @@ "description": "the service provider name", "name": "provider", "response": [ - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -246,18 +184,40 @@ "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", "type": "string" }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" + } + ], + "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": "state of the network provider", - "name": "state", + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", "type": "string" } ], @@ -266,36 +226,76 @@ ], "type": "list" }, - {}, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "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": "true if vpc offering is default, false otherwise", - "name": "isdefault", + "description": "the name of the vpc offering", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", "type": "boolean" }, {}, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the id of the vpc offering", + "name": "id", + "type": "string" + }, + { + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, + {}, + { + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" + }, { "description": "true if network offering supports choosing AS numbers", "name": "specifyasnumber", "type": "boolean" }, { - "description": "indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", + "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 zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", "type": "boolean" } ] @@ -306,27 +306,33 @@ "name": "ldapCreateAccount", "params": [ { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", "length": 255, - "name": "timezone", + "name": "account", "required": false, "type": "string" }, { - "description": "Creates the user under the specified domain.", + "description": "details for account used to store specific parameters", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "accountdetails", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "Account UUID, required for adding account from external provisioning system", "length": 255, - "name": "account", + "name": "accountid", "required": false, "type": "string" }, + { + "description": "Unique username.", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, { "description": "User UUID, required for adding account from external provisioning system", "length": 255, @@ -335,24 +341,25 @@ "type": "string" }, { - "description": "Network domain for the account's networks", + "description": "Creates the account under the specified role.", "length": 255, - "name": "networkdomain", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "details for account used to store specific parameters", + "description": "Network domain for the account's networks", "length": 255, - "name": "accountdetails", + "name": "networkdomain", "required": false, - "type": "map" + "type": "string" }, { - "description": "Unique username.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "username", - "required": true, + "name": "timezone", + "required": false, "type": "string" }, { @@ -363,212 +370,94 @@ "type": "integer" }, { - "description": "Creates the account under the specified role.", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" - }, - { - "description": "Account UUID, required for adding account from external provisioning system", - "length": 255, - "name": "accountid", - "required": false, - "type": "string" } ], "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, { "description": "the total secondary storage space (in GiB) owned by account", "name": "secondarystoragetotal", "type": "float" }, { - "description": "the state of the account", - "name": "state", - "type": "string" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - {}, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "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 tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "id of the Domain the account belongs to", + "name": "domainid", "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 number of public ip addresses this account can acquire", - "name": "iplimit", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, { "description": "the total secondary storage space (in GiB) the account can own", "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, { "description": "the total number of public ip addresses allocated for this account", "name": "iptotal", "type": "long" }, - { - "description": "the name of the account", - "name": "name", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "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 date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { @@ -577,99 +466,28 @@ "type": "boolean" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "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 stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" - }, - {}, - { - "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 total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { @@ -677,379 +495,390 @@ "name": "user", "response": [ { - "description": "the user lastname", - "name": "lastname", + "description": "the ID of the role", + "name": "roleid", "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 ID of the role", - "name": "roleid", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the domain ID of the user", - "name": "domainid", + "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", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user lastname", + "name": "lastname", "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 date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user ID", + "name": "id", + "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the user state", + "name": "state", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the api key of the user", + "name": "apikey", "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": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" } ], "type": "list" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.2.0" - }, - { - "description": "Copies an iso from one zone to another.", - "isasync": true, - "name": "copyIso", - "params": [ - { - "description": "Template ID.", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", - "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" - }, - { - "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": "the name of the role", + "name": "rolename", + "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" - } - ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "response": [ - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "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 type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "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 templates available to be created by this account", + "name": "templateavailable", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, + {}, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the template name", - "name": "name", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "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 network traffic bytes sent", + "name": "sentbytes", "type": "long" }, - {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "details for the account", + "name": "accountdetails", "type": "map" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" }, { - "description": "path of the Domain the template belongs to", + "description": "path of the Domain the account belongs to", "name": "domainpath", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the total number of projects the account can own", + "name": "projectlimit", "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 default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "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 OS type for this template.", - "name": "ostypename", + "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 account name to which the template belongs", - "name": "account", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "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 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": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "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 processor bit size", - "name": "bits", - "type": "int" + "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": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "length": 255, + "name": "destzoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "list" + } + ], + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -1057,29 +886,19 @@ "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": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -1088,31 +907,66 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "id of the resource", + "name": "resourceid", + "type": "string" } ], "type": "set" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "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": "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 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 date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { @@ -1121,33 +975,109 @@ "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { @@ -1156,24 +1086,69 @@ "type": "list" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "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 ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "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": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the size of the template", + "name": "size", + "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 hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, {}, { - "description": "the status of the template", - "name": "status", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { @@ -1182,8 +1157,33 @@ "type": "boolean" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "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 name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { @@ -1192,8 +1192,8 @@ "type": "resourceiconresponse" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" } ] @@ -1214,22 +1214,22 @@ ], "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": "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 current status of the latest async job acting on this object", "name": "jobstatus", @@ -1243,18 +1243,18 @@ "name": "listVsphereStoragePolicyCompatiblePools", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "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": "ID of the zone", @@ -1267,7 +1267,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -1282,16 +1282,30 @@ ], "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, { "description": "the name of the cluster for the storage pool", "name": "clustername", "type": "string" }, - {}, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { "description": "the ID of the cluster for the storage pool", @@ -1299,151 +1313,137 @@ "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the Pod ID of the storage pool", + "name": "podid", "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": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", + "description": "the storage pool custom stats", + "name": "storagecustomstats", "type": "map" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the storage pool", - "name": "name", + "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 storage pool path", + "name": "path", + "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, + {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the storage pool type", - "name": "type", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" - } + }, + {} ] }, { @@ -1451,14 +1451,6 @@ "isasync": true, "name": "rebootSystemVm", "params": [ - { - "description": "The ID of the system virtual machine", - "length": 255, - "name": "id", - "related": "destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", - "required": true, - "type": "uuid" - }, { "description": "Force reboot the system VM (System VM is Stopped and then Started)", "length": 255, @@ -1466,78 +1458,76 @@ "required": false, "since": "4.16.0", "type": "boolean" + }, + { + "description": "The ID of the system virtual machine", + "length": 255, + "name": "id", + "related": "destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "required": true, + "type": "uuid" } ], "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the second DNS for the system VM", + "name": "dns2", "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.", + "description": "the UUID of the latest async job acting on this object", "name": "jobid", "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 control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { @@ -1546,110 +1536,114 @@ "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, - {}, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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 template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", - "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", + "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", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the template name for the system VM", - "name": "templatename", + "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": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "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 ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { @@ -1658,29 +1652,35 @@ "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": "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" } ] }, @@ -1697,34 +1697,34 @@ "type": "string" }, { - "description": "", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the ID of the Zone", + "description": "list dedicated zones by affinity group", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, "type": "uuid" }, { - "description": "list dedicated zones by affinity group", + "description": "", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the name of the account associated with the zone. Must be used with domainId.", @@ -1734,10 +1734,10 @@ "type": "string" }, { - "description": "the ID of the domain associated with the zone", + "description": "the ID of the Zone", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" } @@ -1745,18 +1745,13 @@ "related": "dedicateZone", "response": [ { - "description": "the Name of the Zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "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", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, { @@ -1766,13 +1761,14 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Name of the Zone", + "name": "zonename", + "type": "string" }, + {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -1781,11 +1777,15 @@ "type": "string" }, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -1803,19 +1803,14 @@ ], "related": "", "response": [ - { - "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 current available space of the pool", - "name": "size", + "description": "available iops of the pool", + "name": "maxiops", "type": "long" }, { @@ -1823,6 +1818,18 @@ "name": "gateway", "type": "string" }, + { + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "controller of the pool", + "name": "controllerid", + "type": "string" + }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -1833,23 +1840,16 @@ "name": "id", "type": "string" }, - { - "description": "controller of the pool", - "name": "controllerid", - "type": "string" - }, { "description": "the state of the storage pool", "name": "state", "type": "string" }, { - "description": "available iops of the pool", - "name": "maxiops", + "description": "the current available space of the pool", + "name": "size", "type": "long" - }, - {}, - {} + } ] }, { @@ -1857,14 +1857,6 @@ "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": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", "length": 255, @@ -1872,70 +1864,73 @@ "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForNetwork,changeBgpPeersForVpc", "required": false, "type": "list" + }, + { + "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" } ], "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", "response": [ - {}, { - "description": "id of the bgp peer", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, + {}, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, + {}, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, - {}, - { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" - }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { @@ -1944,19 +1939,24 @@ "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "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", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "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" } ], "since": "4.20.0" @@ -1973,14 +1973,6 @@ "required": false, "type": "integer" }, - { - "description": "the ID of lb rule", - "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - }, { "description": "", "length": 255, @@ -1994,33 +1986,41 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "the ID of lb rule", + "length": 255, + "name": "lbruleid", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": true, + "type": "uuid" } ], "related": "updateTungstenFabricLBHealthMonitor", "response": [ - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, { "description": "the health monitor ID", "name": "id", "type": "long" }, { - "description": "the health monitor expected code", - "name": "expectedcode", + "description": "the health monitor url path", + "name": "urlpath", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the health monitor type", - "name": "type", + "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" }, { @@ -2029,23 +2029,20 @@ "type": "int" }, { - "description": "the health monitor url path", - "name": "urlpath", + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, { - "description": "the health monitor retry", - "name": "retry", - "type": "int" - }, - { - "description": "the health monitor interval", - "name": "interval", - "type": "int" + "description": "the health monitor type", + "name": "type", + "type": "string" }, + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the health monitor http method", + "name": "httpmethod", "type": "string" }, { @@ -2054,22 +2051,25 @@ "type": "integer" }, { - "description": "the health monitor UUID", - "name": "uuid", - "type": "string" + "description": "the health monitor interval", + "name": "interval", + "type": "int" }, - {}, { - "description": "the health monitor http method", - "name": "httpmethod", - "type": "string" + "description": "the health monitor retry", + "name": "retry", + "type": "int" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, - {} + { + "description": "the health monitor expected code", + "name": "expectedcode", + "type": "string" + } ] }, { @@ -2078,33 +2078,22 @@ "name": "deleteAccountFromProject", "params": [ { - "description": "ID of the project to remove the account from", + "description": "name of the account to be removed from the project", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "account", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "name of the account to be removed from the project", + "description": "ID of the project to remove the account from", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, - "type": "string" + "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", @@ -2115,7 +2104,18 @@ "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": "3.0.0" }, @@ -2125,12 +2125,11 @@ "name": "updateGuestOs", "params": [ { - "description": "UUID of the Guest OS", + "description": "Unique display name for Guest OS", "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs,updateGuestOs", + "name": "osdisplayname", "required": true, - "type": "uuid" + "type": "string" }, { "description": "whether this guest OS is available for end users", @@ -2147,23 +2146,30 @@ "type": "map" }, { - "description": "Unique display name for Guest OS", + "description": "UUID of the Guest OS", "length": 255, - "name": "osdisplayname", + "name": "id", + "related": "listOsTypes,addGuestOs,updateGuestOs", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listOsTypes,addGuestOs", "response": [ + {}, { - "description": "the name/description of the OS type", - "name": "description", + "description": "the ID of the OS type", + "name": "id", "type": "string" }, { - "description": "the ID of the OS type", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the OS type", + "name": "name", "type": "string" }, { @@ -2176,32 +2182,26 @@ "name": "oscategoryname", "type": "string" }, + { + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" + }, { "description": "is the guest OS visible for the users", "name": "fordisplay", "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 OS type", - "name": "name", + "description": "the name/description of the OS type", + "name": "description", "type": "string" - }, - { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" } ], "since": "4.4.0" @@ -2212,19 +2212,19 @@ "name": "listGuestVlans", "params": [ { - "description": "list guest vlan by physical network", + "description": "list guest vlan by zone", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list guest vlan by vnet", + "description": "limits search results to allocated guest vlan. false by default.", "length": 255, - "name": "vnet", + "name": "allocatedonly", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -2234,16 +2234,16 @@ "type": "integer" }, { - "description": "list guest vlan by id", + "description": "List by keyword", "length": 255, - "name": "id", + "name": "keyword", "required": false, - "type": "long" + "type": "string" }, { - "description": "List by keyword", + "description": "list guest vlan by vnet", "length": 255, - "name": "keyword", + "name": "vnet", "required": false, "type": "string" }, @@ -2255,19 +2255,19 @@ "type": "integer" }, { - "description": "list guest vlan by zone", + "description": "list guest vlan by physical network", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "limits search results to allocated guest vlan. false by default.", + "description": "list guest vlan by id", "length": 255, - "name": "allocatedonly", + "name": "id", "required": false, - "type": "boolean" + "type": "long" } ], "related": "", @@ -2278,91 +2278,91 @@ "type": "string" }, { - "description": "the project name of the guest VLAN range", - "name": "project", + "description": "the guest VLAN", + "name": "vlan", "type": "string" }, { - "description": "date the guest VLAN was taken", - "name": "taken", - "type": "date" - }, + "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 project id of the guest VLAN range", "name": "projectid", "type": "string" }, { - "description": "the guest VLAN", - "name": "vlan", + "description": "the project name of the guest VLAN range", + "name": "project", "type": "string" }, { - "description": "the physical network name of the guest VLAN range", - "name": "physicalnetworkname", - "type": "string" + "description": "true if the guest VLAN is dedicated to the account", + "name": "isdedicated", + "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the list of networks who use this guest VLAN", - "name": "network", - "type": "list" - }, { "description": "the guest VLAN id", "name": "id", "type": "long" }, { - "description": "path of the domain to which the guest VLAN range belongs", - "name": "domainpath", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, - {}, { - "description": "the allocation state of the guest VLAN", - "name": "allocationstate", + "description": "the physical network ID of the guest VLAN range", + "name": "physicalnetworkid", "type": "string" }, + {}, { "description": "the zone ID of the guest VLAN range", "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of networks who use this guest VLAN", + "name": "network", + "type": "list" }, + {}, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the zone name of the guest VLAN range", + "name": "zonename", "type": "string" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the physical network name of the guest VLAN range", + "name": "physicalnetworkname", "type": "string" }, { - "description": "the zone name of the guest VLAN range", - "name": "zonename", + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", "type": "string" }, { - "description": "the physical network ID of the guest VLAN range", - "name": "physicalnetworkid", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, { - "description": "true if the guest VLAN is dedicated to the account", - "name": "isdedicated", - "type": "boolean" + "description": "date the guest VLAN was taken", + "name": "taken", + "type": "date" } ], "since": "4.17.0" @@ -2372,6 +2372,13 @@ "isasync": false, "name": "updateResourceLimit", "params": [ + { + "description": " Maximum resource limit.", + "length": 255, + "name": "max", + "required": false, + "type": "long" + }, { "description": "Update resource limits for project", "length": 255, @@ -2381,11 +2388,11 @@ "type": "uuid" }, { - "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "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": "account", - "required": false, - "type": "string" + "name": "resourcetype", + "required": true, + "type": "integer" }, { "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.", @@ -2396,91 +2403,84 @@ "type": "uuid" }, { - "description": "Tag for the resource type", + "description": "Update resource for a specified account. Must be used with the domainId parameter.", "length": 255, - "name": "tag", + "name": "account", "required": false, - "since": "4.20.0", "type": "string" }, { - "description": " Maximum resource limit.", + "description": "Tag for the resource type", "length": 255, - "name": "max", + "name": "tag", "required": false, - "type": "long" - }, - { - "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 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": "resourcetype", - "required": true, - "type": "integer" + "since": "4.20.0", + "type": "string" } ], "related": "listResourceLimits", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account of the resource limit", + "name": "account", + "type": "string" }, { - "description": "the project id of the resource limit", - "name": "projectid", + "description": "the project name of the resource limit", + "name": "project", "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "path of the domain to which the resource limit belongs", + "name": "domainpath", "type": "string" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "the domain name of the resource limit", + "name": "domain", "type": "string" }, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "The tag for the resource limit", - "name": "tag", + "description": "the domain ID of the resource limit", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the resource limit", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account of the resource limit", - "name": "account", + "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 project name of the resource limit", - "name": "project", + "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": "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 tag for the resource limit", + "name": "tag", "type": "string" }, { - "description": "path of the domain to which the resource limit belongs", - "name": "domainpath", + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" } ] }, @@ -2499,28 +2499,28 @@ } ], "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": "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" - }, - {} + } ] }, { @@ -2544,27 +2544,27 @@ "name": "key", "type": "string" }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "chain", "name": "chain", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "crt", "name": "crt", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -2583,27 +2583,27 @@ } ], "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": "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" + }, {} ] }, @@ -2613,11 +2613,27 @@ "name": "startRollingMaintenance", "params": [ { - "description": "optional operation timeout (in seconds) that overrides the global timeout setting", + "description": "the IDs of the pods to start maintenance on", "length": 255, - "name": "timeout", + "name": "podids", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "list" + }, + { + "description": "the command to execute while hosts are on maintenance", + "length": 255, + "name": "payload", + "required": false, + "type": "string" + }, + { + "description": "the IDs of the clusters to start maintenance on", + "length": 255, + "name": "clusterids", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "list" }, { "description": "the IDs of the zones to start maintenance on", @@ -2631,7 +2647,7 @@ "description": "the IDs of the hosts to start maintenance on", "length": 255, "name": "hostids", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "required": false, "type": "list" }, @@ -2643,101 +2659,85 @@ "type": "boolean" }, { - "description": "the command to execute while hosts are on maintenance", - "length": 255, - "name": "payload", - "required": false, - "type": "string" - }, - { - "description": "the IDs of the clusters to start maintenance on", - "length": 255, - "name": "clusterids", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "list" - }, - { - "description": "the IDs of the pods to start maintenance on", + "description": "optional operation timeout (in seconds) that overrides the global timeout setting", "length": 255, - "name": "podids", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "timeout", "required": false, - "type": "list" + "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "the hosts updated", - "name": "hostsupdated", + "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": "the hosts skipped", + "name": "hostsskipped", "response": [ { - "description": "the ID of the updated host", + "description": "the ID of the skipped host", "name": "hostid", "type": "string" }, { - "description": "output of the maintenance script on the host", - "name": "output", + "description": "the name of the skipped host", + "name": "hostname", "type": "string" }, { - "description": "start date of the update on the host", - "name": "startdate", + "description": "the reason to skip the host", + "name": "reason", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "the hosts updated", + "name": "hostsupdated", + "response": [ { "description": "end date of the update on the host", "name": "enddate", "type": "string" }, { - "description": "the name of the updated host", - "name": "hostname", + "description": "output of the maintenance script on the host", + "name": "output", "type": "string" - } - ], - "type": "list" - }, - { - "description": "in case of failure, details are displayed", - "name": "details", - "type": "string" - }, - { - "description": "indicates if the rolling maintenance operation was successful", - "name": "success", - "type": "boolean" - }, - { - "description": "the hosts skipped", - "name": "hostsskipped", - "response": [ + }, { - "description": "the reason to skip the host", - "name": "reason", + "description": "the name of the updated host", + "name": "hostname", "type": "string" }, { - "description": "the ID of the skipped host", + "description": "the ID of the updated host", "name": "hostid", "type": "string" }, { - "description": "the name of the skipped host", - "name": "hostname", + "description": "start date of the update on the host", + "name": "startdate", "type": "string" } ], "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", @@ -2751,26 +2751,19 @@ "isasync": false, "name": "listTungstenFabricApplicationPolicySet", "params": [ - { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "pagesize", + "name": "applicationpolicysetuuid", "required": false, - "type": "integer" + "type": "string" }, { "description": "List by keyword", @@ -2786,10 +2779,32 @@ "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "createTungstenFabricApplicationPolicySet", "response": [ + { + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", @@ -2801,37 +2816,22 @@ "type": "integer" }, { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" }, - {}, - {}, { "description": "Tungsten-Fabric policy name", "name": "name", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" - } + {} ] }, { @@ -2848,12 +2848,11 @@ "type": "boolean" }, { - "description": "the ID of the network ACL", + "description": "Name of the network ACL list", "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -2864,11 +2863,12 @@ "type": "string" }, { - "description": "Name of the network ACL list", + "description": "the ID of the network ACL", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": true, + "type": "uuid" }, { "description": "Description of the network ACL list", @@ -2879,28 +2879,28 @@ } ], "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": "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.4" }, @@ -2910,152 +2910,437 @@ "name": "restoreVirtualMachine", "params": [ { - "description": "used to specify the custom parameters", + "description": "Virtual Machine ID", "length": 255, - "name": "details", - "required": false, - "since": "4.19.1", - "type": "map" + "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "Override root volume's diskoffering.", + "description": "Optional field to expunge old root volume after restore.", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "expunge", "required": false, "since": "4.19.1", - "type": "uuid" + "type": "boolean" }, { - "description": "Override root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "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": "rootdisksize", + "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, - "since": "4.19.1", - "type": "long" + "type": "uuid" }, { - "description": "Virtual Machine ID", + "description": "Override root volume's diskoffering.", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": true, + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": false, + "since": "4.19.1", "type": "uuid" }, { - "description": "Optional field to expunge old root volume after restore.", + "description": "used to specify the custom parameters", "length": 255, - "name": "expunge", + "name": "details", "required": false, "since": "4.19.1", - "type": "boolean" + "type": "map" }, { - "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": "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": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "rootdisksize", "required": false, - "type": "uuid" + "since": "4.19.1", + "type": "long" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ { - "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "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 VM's disk read in KiB", + "name": "diskkbsread", + "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", + "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 domain ID of the affinity group", + "name": "domainid", + "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 ID of the affinity group", + "name": "id", + "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" + }, + { + "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 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 date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "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": "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + {}, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the ID of the security group", + "description": "the ID of the corresponding network", + "name": "networkid", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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": "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 account owning the security group", - "name": "account", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "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 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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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": "the name of the security group", - "name": "name", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "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" + } + ], + "type": "set" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "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 security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { "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": "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": "the ID of the domain associated with the tag", - "name": "domainid", + "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" }, { @@ -3068,14 +3353,19 @@ "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 id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -3084,31 +3374,31 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -3117,18 +3407,18 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -3137,31 +3427,41 @@ "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 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": "account owning the security group rule", - "name": "account", + "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", + "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": "security group name", @@ -3169,8 +3469,8 @@ "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -3178,8 +3478,8 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -3188,23 +3488,23 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -3213,46 +3513,46 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], @@ -3263,38 +3563,18 @@ "name": "domain", "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 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", + "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" }, { @@ -3303,33 +3583,33 @@ "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": "customer associated with the tag", + "name": "customer", "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 key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "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" }, { @@ -3338,684 +3618,414 @@ "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" }, { - "description": "the project id of the group", - "name": "projectid", + "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 account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "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 domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", "type": "string" } ], "type": "set" }, - {}, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, - {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "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", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "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": "Base64 string containing the user data", - "name": "userdata", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "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": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, - {}, { "description": "the vGPU type used by the virtual machine", "name": "vgpu", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", - "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": "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" - }, - { - "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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 format of the template for the virtual machine", + "name": "templateformat", + "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": "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": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain 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": "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": "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 ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "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": "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 ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "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 ID of the corresponding network", - "name": "networkid", - "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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "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 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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the account associated with the tag", + "name": "account", "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": "the project name where tag belongs to", + "name": "project", "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 ip address of the nic", - "name": "ipaddress", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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": "the domain associated with the tag", + "name": "domain", "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": "the name of the corresponding network", - "name": "networkname", + "description": "tag key name", + "name": "key", "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": "tag value", + "name": "value", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, - { - "description": "the ID of the virtual machine", - "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 virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, { "description": "true if the password rest feature is enabled, false otherwise", "name": "passwordenabled", "type": "boolean" }, - { - "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": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "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 ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "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 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 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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { "description": "the memory used by the VM in KiB", @@ -4023,33 +4033,23 @@ "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "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" } ], @@ -4070,28 +4070,28 @@ } ], "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" }, - {}, - { - "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" - } + {} ] }, { @@ -4108,18 +4108,18 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -4136,38 +4136,38 @@ "name": "ucsmanagerid", "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": "ucs blade id", + "name": "id", + "type": "string" + }, { "description": "associated ucs profile dn", "name": "profiledn", "type": "string" }, { - "description": "ucs blade id", - "name": "id", + "description": "ucs blade dn", + "name": "bladedn", "type": "string" }, + {}, { - "description": "cloudstack host id this blade associates to", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ucs blade dn", - "name": "bladedn", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" - } + }, + {} ] }, { @@ -4185,9 +4185,9 @@ ], "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", @@ -4200,12 +4200,12 @@ "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" + } ] }, { @@ -4223,12 +4223,6 @@ ], "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", @@ -4239,7 +4233,13 @@ "name": "jobid", "type": "string" }, - {} + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -4248,26 +4248,19 @@ "name": "updateHost", "params": [ { - "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable", + "description": "the id of Os category to update the host with", "length": 255, - "name": "allocationstate", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "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": "istagarule", + "name": "allocationstate", "required": false, - "type": "boolean" - }, - { - "description": "the ID of the host to update", - "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", - "required": true, - "type": "uuid" + "type": "string" }, { "description": "Add an annotation to this host", @@ -4277,13 +4270,6 @@ "since": "4.11", "type": "string" }, - { - "description": "the new uri for the secondary storage: nfs://host/path", - "length": 255, - "name": "url", - "required": false, - "type": "string" - }, { "description": "list of tags to be added to the host", "length": 255, @@ -4300,54 +4286,84 @@ "type": "string" }, { - "description": "the id of Os category to update the host with", + "description": "the ID of the host to update", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": false, + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "required": true, "type": "uuid" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "length": 255, + "name": "istagarule", + "required": false, + "type": "boolean" + }, + { + "description": "the new uri for the secondary storage: nfs://host/path", + "length": 255, + "name": "url", + "required": false, + "type": "string" } ], - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "response": [ + { + "description": "the host version", + "name": "version", + "type": "string" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "events available for the host", + "name": "events", + "type": "string" + }, { "description": "the OS category name of the host", "name": "oscategoryname", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "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 date and time the host was created", - "name": "created", - "type": "date" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "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": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "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 in percentage", - "name": "cpuallocatedpercentage", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { @@ -4361,28 +4377,39 @@ "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "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", + "description": "the ID of the host", + "name": "id", "type": "string" }, + {}, { - "description": "the ID of the host", - "name": "id", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { @@ -4391,55 +4418,59 @@ "type": "boolean" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "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": "CPU Arch of the host", + "name": "arch", + "type": "string" + }, { "description": "the date and time the host was last pinged", "name": "lastpinged", "type": "date" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "true if this host 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", + "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 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": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, - {}, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { "description": "the total disk size of the host", @@ -4447,23 +4478,8 @@ "type": "long" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -4471,104 +4487,48 @@ "name": "networkkbsread", "type": "long" }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" - }, { "description": "the cluster ID of the host", "name": "clusterid", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "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 used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - {}, - { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, { "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": "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", @@ -4581,8 +4541,8 @@ "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { @@ -4590,116 +4550,156 @@ "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": "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": "Model Name of vGPU", + "name": "vgputype", + "type": "string" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "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 Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "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 number of CPU sockets on the host", - "name": "cpusockets", + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { "description": "the CPU speed of the host", "name": "cpuspeed", "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 cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" } ] }, @@ -4708,34 +4708,6 @@ "isasync": true, "name": "createEgressFirewallRule", "params": [ - { - "description": "the starting port of firewall rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" - }, - { - "description": "type of the icmp message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - }, - { - "description": "the ending port of firewall rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, - { - "description": "error code for this icmp message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" - }, { "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, @@ -4744,19 +4716,19 @@ "type": "list" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the starting port of firewall rule", "length": 255, - "name": "fordisplay", + "name": "startport", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "type of firewallrule: system/user", + "description": "the network id of the port forwarding rule", "length": 255, - "name": "type", - "required": false, - "type": "string" + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", @@ -4773,105 +4745,67 @@ "type": "list" }, { - "description": "the network id of the port forwarding rule", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - } - ], - "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", - "response": [ - { - "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 public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" - }, - { - "description": "is rule for display to the regular user", "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, { "description": "error code for this icmp message", + "length": 255, "name": "icmpcode", + "required": false, "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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 traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "type of firewallrule: system/user", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "the ending port of firewall rule's port range", + "description": "the ending port of firewall rule", + "length": 255, "name": "endport", + "required": false, "type": "integer" }, { "description": "type of the icmp message being sent", + "length": 255, "name": "icmptype", + "required": false, "type": "integer" - }, + } + ], + "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", + "response": [ + {}, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -4880,8 +4814,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -4890,23 +4824,18 @@ "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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -4915,18 +4844,89 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, { "description": "the public ip address id for the firewall rule", "name": "ipaddressid", "type": "string" - } + }, + { + "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 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 ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + {} ] }, { @@ -4935,12 +4935,18 @@ "name": "listSecurityGroups", "params": [ { - "description": "lists security groups by virtual machine id", + "description": "List by keyword", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { "description": "list only resources belonging to the domain specified", @@ -4958,18 +4964,12 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "lists security groups by virtual machine id", "length": 255, - "name": "keyword", + "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "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.", @@ -4979,27 +4979,26 @@ "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list the security group by the id provided", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "list the security group by the id provided", + "description": "", "length": 255, - "name": "id", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "pagesize", "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.", @@ -5009,53 +5008,181 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "account", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createSecurityGroup,updateSecurityGroup", "response": [ + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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 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": "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": "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": "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" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, { "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 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 protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "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": "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", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -5064,147 +5191,139 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "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": "customer associated with the tag", + "name": "customer", "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { "description": "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": "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": "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" } ], "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 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 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 protocol of the security group rule", - "name": "protocol", + "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", + "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", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "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 domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -5213,18 +5332,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -5232,6 +5351,11 @@ "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", @@ -5240,16 +5364,6 @@ ], "type": "set" }, - { - "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", @@ -5259,176 +5373,29 @@ "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 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 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": "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": "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 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 project name of the group", - "name": "project", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, { - "description": "Enables a role", + "description": "List OAuth providers registered", "isasync": false, - "name": "enableRole", + "name": "listOauthProvider", "params": [ { - "description": "ID of the role", + "description": "Name of the provider", "length": 255, - "name": "id", - "related": "createRole,importRole,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": "any text associated with the success or failure", - "name": "displaytext", + "name": "provider", + "required": false, "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "List OAuth providers registered", - "isasync": false, - "name": "listOauthProvider", - "params": [ { "description": "", "length": 255, @@ -5436,14 +5403,6 @@ "required": false, "type": "integer" }, - { - "description": "the ID of the OAuth provider", - "length": 255, - "name": "id", - "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -5452,18 +5411,19 @@ "type": "string" }, { - "description": "Name of the provider", + "description": "", "length": 255, - "name": "provider", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the ID of the OAuth provider", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", @@ -5474,14 +5434,14 @@ "type": "string" }, { - "description": "Name of the provider", - "name": "provider", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "ID of the provider", @@ -5489,8 +5449,8 @@ "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "Name of the provider", + "name": "provider", "type": "string" }, { @@ -5498,67 +5458,107 @@ "name": "description", "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": "Client ID registered in the OAuth provider", "name": "clientid", "type": "string" }, + {}, { "description": "Secret key registered in the OAuth provider", "name": "secretkey", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" } ], "since": "4.19.0" }, { - "description": "Delete Service Package", + "description": "Enables a role", "isasync": false, - "name": "deleteServicePackageOffering", + "name": "enableRole", "params": [ { - "description": "the service offering ID", + "description": "ID of the role", "length": 255, "name": "id", - "related": "registerNetscalerServicePackage,listRegisteredServicePackages", + "related": "createRole,importRole,listRoles,updateRole", "required": true, - "type": "string" + "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": "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": "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 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" } ] }, @@ -5593,59 +5593,49 @@ "related": "createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, - {}, { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "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": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, + {}, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { @@ -5654,23 +5644,33 @@ "type": "integer" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { @@ -5678,13 +5678,13 @@ "name": "tags", "response": [ { - "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -5693,28 +5693,23 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -5728,88 +5723,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, - { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "ID of the shared filesystem", - "name": "id", - "type": "string" - }, - { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", - "type": "string" - }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" - }, - { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" - }, - { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" - }, { "description": "Network ID of the shared filesystem", "name": "networkid", @@ -5820,13 +5745,28 @@ "name": "nic", "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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 type of the nic", + "name": "type", + "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" }, { @@ -5835,8 +5775,8 @@ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -5845,49 +5785,49 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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" + "name": "isdefault", + "type": "boolean" }, { - "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": "MTU configured on the NIC", @@ -5895,96 +5835,101 @@ "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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", + "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", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "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", + "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", + "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "list" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { @@ -5994,24 +5939,39 @@ }, {}, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "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 state of the shared filesystem", + "name": "state", + "type": "string" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" }, { "description": "service offering ID for the shared filesystem", @@ -6019,13 +5979,53 @@ "type": "string" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" } ], @@ -6036,13 +6036,6 @@ "isasync": true, "name": "updateIpv4SubnetForZone", "params": [ - { - "description": "The new CIDR of the IPv4 subnet.", - "length": 255, - "name": "subnet", - "required": true, - "type": "string" - }, { "description": "Id of the guest network IPv4 subnet", "length": 255, @@ -6050,18 +6043,20 @@ "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": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "id of the guest IPv4 subnet", - "name": "id", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, {}, @@ -6071,13 +6066,24 @@ "type": "string" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, + {}, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { @@ -6085,25 +6091,19 @@ "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 of the IPv4 subnet", - "name": "domainid", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { @@ -6112,8 +6112,8 @@ "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" } ], @@ -6136,69 +6136,69 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "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 Pod name for the system VM", + "name": "podname", + "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, - {}, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { @@ -6207,53 +6207,48 @@ "type": "list" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" - }, - { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { @@ -6262,58 +6257,64 @@ "type": "integer" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "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 link local MAC address for the system vm", - "name": "linklocalmacaddress", - "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 template ID for the system VM", - "name": "templateid", + "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", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "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 network domain for the system VM", - "name": "networkdomain", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { @@ -6322,31 +6323,30 @@ "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - {} + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" + } ] }, { @@ -6355,12 +6355,11 @@ "name": "archiveEvents", "params": [ { - "description": "the IDs of the events", + "description": "archive by event type", "length": 255, - "name": "ids", - "related": "listEvents", + "name": "type", "required": false, - "type": "list" + "type": "string" }, { "description": "end date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", @@ -6370,21 +6369,23 @@ "type": "date" }, { - "description": "archive by event type", + "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": "type", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { - "description": "start date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "the IDs of the events", "length": 255, - "name": "startdate", + "name": "ids", + "related": "listEvents", "required": false, - "type": "date" + "type": "list" } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -6400,13 +6401,12 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {}, - {} + } ] }, { @@ -6415,12 +6415,11 @@ "name": "listASNumbers", "params": [ { - "description": "the vpc id", + "description": "List by keyword", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "AS number", @@ -6431,18 +6430,18 @@ "type": "integer" }, { - "description": "the AS Number range ID", + "description": "the network id", "length": 255, - "name": "asnrangeid", - "related": "createASNRange,listASNRanges", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "the zone ID", + "description": "the AS Number range ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "asnrangeid", + "related": "createASNRange,listASNRanges", "required": false, "type": "uuid" }, @@ -6454,11 +6453,12 @@ "type": "integer" }, { - "description": "to indicate if the AS number is allocated to any network", + "description": "domain id", "length": 255, - "name": "isallocated", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "account name", @@ -6469,32 +6469,32 @@ "type": "string" }, { - "description": "", + "description": "the zone ID", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "domain id", + "description": "to indicate if the AS number is allocated to any network", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "isallocated", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the network id", + "description": "the vpc id", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" } @@ -6502,18 +6502,29 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Network Name", + "name": "associatednetworkname", + "type": "string" }, { - "description": "Domain ID", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "AS Number ID", - "name": "asnrangeid", + "description": "the domain name", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the AS Number", + "name": "id", + "type": "string" + }, + { + "description": "the account name", + "name": "account", "type": "string" }, { @@ -6522,18 +6533,19 @@ "type": "string" }, { - "description": "Created Date", - "name": "created", + "description": "Allocated Date", + "name": "allocated", "type": "date" }, + {}, { - "description": "AS Number", - "name": "asnumber", - "type": "long" + "description": "Created Date", + "name": "created", + "type": "date" }, { - "description": "the domain name", - "name": "domain", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, { @@ -6541,61 +6553,49 @@ "name": "zonename", "type": "string" }, - {}, { "description": "VPC ID", "name": "vpcid", "type": "string" }, { - "description": "Allocated Date", - "name": "allocated", - "type": "date" + "description": "AS Number ID", + "name": "asnrangeid", + "type": "string" }, { - "description": "the account name", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Zone ID", - "name": "zoneid", + "description": "Allocation state", + "name": "allocationstate", "type": "string" }, { - "description": "Network Name", - "name": "associatednetworkname", + "description": "VPC Name", + "name": "vpcname", "type": "string" }, - {}, { "description": "Account ID", "name": "accountid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "AS Number Range", - "name": "asnrange", - "type": "string" - }, - { - "description": "Allocation state", - "name": "allocationstate", - "type": "string" + "description": "AS Number", + "name": "asnumber", + "type": "long" }, { - "description": "ID of the AS Number", - "name": "id", + "description": "Domain ID", + "name": "domainid", "type": "string" }, { - "description": "VPC Name", - "name": "vpcname", + "description": "AS Number Range", + "name": "asnrange", "type": "string" } ], @@ -6621,6 +6621,12 @@ "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", @@ -6631,13 +6637,7 @@ "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" }, @@ -6646,20 +6646,6 @@ "isasync": false, "name": "listUserData", "params": [ - { - "description": "Userdata name to look for", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -6669,41 +6655,40 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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 ID of the Userdata", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listUserData", + "name": "keyword", "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": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -6712,29 +6697,44 @@ "required": false, "type": "integer" }, + { + "description": "the ID of the Userdata", + "length": 255, + "name": "id", + "related": "listUserData", + "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": "Userdata name to look for", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the project id of the userdata", - "name": "projectid", + "description": "the domain id of the userdata owner", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project name of the userdata", + "name": "project", + "type": "string" }, { - "description": "Name of the userdata", - "name": "name", + "description": "the project id of the userdata", + "name": "projectid", "type": "string" }, { @@ -6743,8 +6743,8 @@ "type": "string" }, { - "description": "the domain name of the userdata owner", - "name": "domain", + "description": "the owner of the userdata", + "name": "account", "type": "string" }, { @@ -6754,44 +6754,44 @@ }, {}, { - "description": "the domain id of the userdata owner", - "name": "domainid", + "description": "base64 encoded userdata content", + "name": "userdata", "type": "string" }, { - "description": "path of the domain to which the userdata owner belongs", - "name": "domainpath", + "description": "the domain name of the userdata owner", + "name": "domain", "type": "string" }, { - "description": "ID of the ssh keypair", - "name": "id", + "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 project name of the userdata", - "name": "project", - "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": "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", + "description": "path of the domain to which the userdata owner belongs", + "name": "domainpath", "type": "string" }, { - "description": "the owner of the userdata", - "name": "account", + "description": "Name of the userdata", + "name": "name", "type": "string" }, + {}, { - "description": "base64 encoded userdata content", - "name": "userdata", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" } ], @@ -6802,19 +6802,11 @@ "isasync": true, "name": "updateLoadBalancer", "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 ID of the load balancer", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": true, "type": "uuid" }, @@ -6825,23 +6817,89 @@ "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": "createLoadBalancer,listLoadBalancers", "response": [ + { + "description": "the project name of the Load Balancer", + "name": "project", + "type": "string" + }, + {}, + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" + }, + { + "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 load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "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": "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": "the description of the Load Balancer", "name": "description", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "the domain of the Load Balancer", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { @@ -6850,13 +6908,13 @@ "type": "string" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -6864,10 +6922,20 @@ "name": "sourceipaddressnetworkid", "type": "string" }, + { + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" + }, { "description": "the list of instances associated with the Load Balancer", "name": "loadbalancerinstance", "response": [ + { + "description": "the state of the instance", + "name": "state", + "type": "string" + }, { "description": "the ip address of the instance", "name": "ipaddress", @@ -6878,11 +6946,6 @@ "name": "id", "type": "string" }, - { - "description": "the state of the instance", - "name": "state", - "type": "string" - }, { "description": "the name of the instance", "name": "name", @@ -6891,50 +6954,34 @@ ], "type": "list" }, - { - "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" - }, {}, - { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, { "description": "Load Balancer network id", "name": "networkid", "type": "string" }, - { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" - }, - {}, { "description": "the list of resource tags associated with the Load Balancer", "name": "tags", "response": [ { - "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": "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", "type": "string" }, { @@ -6943,18 +6990,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the 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" }, { @@ -6963,64 +7010,17 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "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" - } - ], - "type": "list" - }, - { - "description": "the name of the Load Balancer", - "name": "name", - "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": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" } ], "type": "list" - }, - { - "description": "the domain of the Load Balancer", - "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": "4.4.0" @@ -7031,12 +7031,11 @@ "name": "scaleSystemVm", "params": [ { - "description": "The ID of the system vm", + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", - "required": true, - "type": "uuid" + "name": "details", + "required": false, + "type": "map" }, { "description": "the service offering ID to apply to the system vm", @@ -7047,38 +7046,39 @@ "type": "uuid" }, { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "The ID of the system vm", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "required": true, + "type": "uuid" } ], "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "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 hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { @@ -7087,39 +7087,39 @@ "type": "boolean" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, {}, { - "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": "the template ID for the system VM", - "name": "templateid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "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 Zone name for the system VM", - "name": "zonename", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { @@ -7128,124 +7128,124 @@ "type": "list" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "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": "the number of active console sessions for the console proxy system vm", "name": "activeviewersessions", "type": "integer" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "guest vlan range", + "name": "guestvlan", "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 first DNS for the system VM", "name": "dns1", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { @@ -7254,18 +7254,18 @@ "type": "date" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "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 last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" } ] @@ -7276,11 +7276,18 @@ "name": "verifyOAuthCodeAndGetUser", "params": [ { - "description": "", + "description": "Name of the provider", "length": 255, - "name": "pagesize", + "name": "provider", + "required": true, + "type": "string" + }, + { + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "length": 255, + "name": "secretcode", "required": false, - "type": "integer" + "type": "string" }, { "description": "List by keyword", @@ -7292,42 +7299,39 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "description": "", "length": 255, - "name": "secretcode", + "name": "page", "required": false, - "type": "string" - }, - { - "description": "Name of the provider", - "length": 255, - "name": "provider", - "required": true, - "type": "string" + "type": "integer" } ], "related": "updateOauthProvider", "response": [ - {}, { - "description": "ID of the provider", - "name": "id", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, + { + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" + }, { "description": "Name of the provider", - "name": "provider", + "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", + "type": "string" }, { "description": "Redirect URI registered in the OAuth provider", @@ -7335,33 +7339,29 @@ "type": "string" }, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", - "type": "string" - }, - { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, { "description": "Name of the provider", - "name": "name", + "name": "provider", "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "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", + "description": "ID of the provider", + "name": "id", "type": "string" }, { - "description": "Description of the provider registered", - "name": "description", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, {} @@ -7374,18 +7374,12 @@ "name": "listClusterDrsPlan", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "ID of the drs plan", "length": 255, - "name": "page", + "name": "id", + "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -7395,67 +7389,73 @@ "type": "string" }, { - "description": "ID of the drs plan", + "description": "ID of the cluster", "length": 255, - "name": "id", - "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, "type": "uuid" }, { - "description": "ID of the cluster", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "generateClusterDrsPlan,executeClusterDrsPlan", "response": [ { - "description": "List of migrations", - "name": "migrations", - "type": "list" - }, - { - "description": "Id of the cluster", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" - }, - {}, - { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" - }, - {}, {}, { "description": "unique ID of the drs plan for cluster", "name": "id", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "Start event Id of the DRS Plan", "name": "eventid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" + }, + { + "description": "List of migrations", + "name": "migrations", + "type": "list" + }, + { + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "Status of DRS Plan", + "name": "status", + "type": "status" + }, + {} ], "since": "4.19.0" }, @@ -7465,26 +7465,27 @@ "name": "listClusters", "params": [ { - "description": "lists clusters by the cluster ID", + "description": "lists clusters by Pod ID", "length": 255, - "name": "id", - "related": "addCluster,listClusters,updateCluster", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "lists clusters by cluster type", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "clustertype", + "name": "id", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists clusters by hypervisor type", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "hypervisor", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -7494,26 +7495,26 @@ "type": "integer" }, { - "description": "lists clusters by allocation state", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "allocationstate", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "lists clusters by Pod ID", + "description": "lists clusters by Zone ID", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "lists clusters by allocation state", "length": 255, - "name": "page", + "name": "allocationstate", "required": false, - "type": "integer" + "type": "string" }, { "description": "whether this cluster is managed by cloudstack", @@ -7523,166 +7524,78 @@ "type": "string" }, { - "description": "lists clusters by the cluster name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "flag to display the capacity of the clusters", + "description": "lists clusters by the cluster name", "length": 255, - "name": "showcapacities", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "lists clusters by Zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "lists clusters by cluster type", "length": 255, - "name": "keyword", + "name": "clustertype", "required": false, "type": "string" } ], "related": "addCluster,updateCluster", "response": [ - { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", - "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 cluster", - "name": "zonename", - "type": "string" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "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": "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": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", - "type": "string" - }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, { "description": "the capacity name", "name": "name", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Zone ID", + "name": "zoneid", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { "description": "the percentage of capacity currently in use", "name": "percentused", "type": "string" }, - { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" - }, { "description": "the capacity currently in use", "name": "capacityused", "type": "long" }, { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { @@ -7691,32 +7604,119 @@ "type": "string" }, { - "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 Zone name", "name": "zonename", "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" } ], "type": "list" }, + {}, + { + "description": "the Zone name of the cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Pod name of the cluster", + "name": "podname", + "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 type of the cluster", + "name": "clustertype", + "type": "string" + }, { "description": "the hypervisor type of the cluster", "name": "hypervisortype", "type": "string" + }, + { + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "the cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + {}, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", + "type": "string" + }, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" } ] }, @@ -7726,76 +7726,76 @@ "name": "listProjectInvitations", "params": [ { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list invitations by id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "id", + "related": "listProjectInvitations", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", "length": 255, - "name": "isrecursive", + "name": "activeonly", "required": false, "type": "boolean" }, { - "description": "list invitations by state", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list invitation by user ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list by project id", "length": 255, - "name": "listall", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "list invitations by state", "length": 255, - "name": "pagesize", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list by project id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list invitations by id", + "description": "list invitation by user ID", "length": 255, - "name": "id", - "related": "listProjectInvitations", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, @@ -7807,39 +7807,34 @@ "type": "integer" }, { - "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", + "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": "activeonly", + "name": "listall", "required": false, "type": "boolean" } ], "related": "", "response": [ + {}, { - "description": "the invitation state", - "name": "state", - "type": "string" - }, - { - "description": "the name of the project", - "name": "project", + "description": "the id of the invitation", + "name": "id", "type": "string" }, { - "description": "the id of the project", - "name": "projectid", - "type": "string" + "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", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { @@ -7848,35 +7843,40 @@ "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the invitation state", + "name": "state", "type": "string" }, { - "description": "the email the invitation was sent to", - "name": "email", + "description": "the id of the project", + "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 project", + "name": "project", + "type": "string" }, { "description": "the User ID", "name": "userid", "type": "string" }, - {}, { - "description": "the id of the invitation", - "name": "id", + "description": "the email the invitation was sent to", + "name": "email", "type": "string" }, + {}, { "description": "path of the Domain the project belongs to", "name": "domainpath", "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -7887,17 +7887,32 @@ "name": "listEgressFirewallRules", "params": [ { - "description": "the ID of IP address of the firewall services", + "description": "List by keyword", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the network ID for the egress firewall services", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -7909,91 +7924,96 @@ "type": "boolean" }, { - "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": "Lists rule with the specified ID.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "tags", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "List by keyword", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "keyword", + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the network ID for the egress firewall services", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "fordisplay", + "name": "tags", "required": false, - "since": "4.4", - "type": "boolean" - }, + "type": "map" + } + ], + "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", + "response": [ { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": false, - "type": "uuid" - } - ], - "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", - "response": [ + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "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": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { @@ -8002,18 +8022,23 @@ "type": "integer" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "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 traffic type for the firewall rule", - "name": "traffictype", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -8021,113 +8046,88 @@ "name": "protocol", "type": "string" }, + { + "description": "the network id of the firewall rule", + "name": "networkid", + "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", + "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 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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "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": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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": "the ID of the firewall rule", - "name": "id", - "type": "string" - }, - { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, {}, {}, { - "description": "the ending port of firewall rule's port range", - "name": "endport", + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { - "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 public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the state of the rule", + "name": "state", "type": "string" } ] @@ -8138,25 +8138,25 @@ "name": "listClustersMetrics", "params": [ { - "description": "List by keyword", + "description": "lists clusters by allocation state", "length": 255, - "name": "keyword", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "lists clusters by the cluster name", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "name", + "name": "managedstate", "required": false, "type": "string" }, { - "description": "lists clusters by allocation state", + "description": "", "length": 255, - "name": "allocationstate", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "flag to display the capacity of the clusters", @@ -8166,19 +8166,26 @@ "type": "boolean" }, { - "description": "lists clusters by Zone ID", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "lists clusters by the cluster ID", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "", + "description": "lists clusters by the cluster name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "lists clusters by Pod ID", @@ -8189,38 +8196,31 @@ "type": "uuid" }, { - "description": "", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "pagesize", + "name": "hypervisor", "required": false, - "type": "integer" + "type": "string" }, { - "description": "lists clusters by the cluster ID", + "description": "lists clusters by Zone ID", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "lists clusters by cluster type", - "length": 255, - "name": "clustertype", - "required": false, - "type": "string" - }, - { - "description": "lists clusters by hypervisor type", + "description": "", "length": 255, - "name": "hypervisor", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "lists clusters by cluster type", "length": 255, - "name": "managedstate", + "name": "clustertype", "required": false, "type": "string" } @@ -8228,78 +8228,78 @@ "related": "", "response": [ { - "description": "DRS imbalance for the cluster", - "name": "drsimbalance", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", - "type": "string" + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "running / total hosts in the cluster", + "name": "hosts", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, - { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", - "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": "cpu allocated notification threshold exceeded", "name": "cpuallocatedthreshold", "type": "boolean" }, + { + "description": "state of the cluster", + "name": "state", + "type": "string" + }, + { + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", + "type": "string" + }, { "description": "The cpu overcommit ratio of the cluster", "name": "cpuovercommitratio", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "the total cpu used in GiB", + "name": "memoryused", "type": "string" }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "the total cpu used in Ghz", + "name": "cpuused", "type": "string" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { @@ -8312,53 +8312,125 @@ "name": "memorydisablethreshold", "type": "boolean" }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "the Zone name of the cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + { + "description": "DRS imbalance for the cluster", + "name": "drsimbalance", + "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + {}, + {}, + { + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "the cluster name", + "name": "name", + "type": "string" + }, + { + "description": "the total cpu capacity in GiB", + "name": "memorytotal", + "type": "string" + }, + { + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "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", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the capacity name", - "name": "name", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { @@ -8367,57 +8439,27 @@ "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" } ], "type": "list" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" - }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "state of the cluster", - "name": "state", - "type": "string" - }, - { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the total cpu used in GiB", - "name": "memoryused", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "cpu usage notification threshold exceeded", @@ -8425,13 +8467,8 @@ "type": "boolean" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, { @@ -8439,51 +8476,14 @@ "name": "id", "type": "string" }, - {}, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" - }, - { - "description": "the total cpu used in Ghz", - "name": "cpuused", - "type": "string" - }, - {}, - { - "description": "running / total hosts in the cluster", - "name": "hosts", - "type": "string" - }, - { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" - }, { "description": "CPU Arch of the hosts in the cluster", "name": "arch", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" } ], @@ -8494,13 +8494,6 @@ "isasync": false, "name": "listStoragePoolObjects", "params": [ - { - "description": "path to list on storage pool", - "length": 255, - "name": "path", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -8509,11 +8502,11 @@ "type": "integer" }, { - "description": "", + "description": "path to list on storage pool", "length": 255, - "name": "pagesize", + "name": "path", "required": false, - "type": "integer" + "type": "string" }, { "description": "List by keyword", @@ -8522,6 +8515,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "id of the storage pool", "length": 255, @@ -8533,62 +8533,62 @@ ], "related": "listImageStoreObjects", "response": [ + {}, { - "description": "Template ID associated with the data store object.", - "name": "templateid", - "type": "string" + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" }, { - "description": "Volume Name associated with the data store object.", - "name": "volumename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Name of the data store object.", - "name": "name", + "description": "Template Name associated with the data store object.", + "name": "templatename", "type": "string" }, - { - "description": "Size is in Bytes.", - "name": "size", - "type": "long" - }, {}, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Is it a directory.", - "name": "isdirectory", - "type": "boolean" + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" }, { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", + "description": "Template ID associated with the data store object.", + "name": "templateid", "type": "string" }, { - "description": "Template Name associated with the data store object.", - "name": "templatename", + "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": "Snapshot ID associated with the data store object.", + "name": "snapshotid", + "type": "string" }, { - "description": "Format of template associated with the data store object.", - "name": "format", + "description": "Volume Name associated with the data store object.", + "name": "volumename", "type": "string" }, { - "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": "Name of the data store object.", + "name": "name", + "type": "string" }, { "description": "Snapshot Name associated with the data store object.", @@ -8596,8 +8596,8 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Volume ID associated with the data store object.", + "name": "volumeid", "type": "string" } ], @@ -8609,31 +8609,17 @@ "name": "listSecondaryStagingStores", "params": [ { - "description": "the name of the staging store", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the Zone ID for the staging store", + "description": "the ID of the staging store", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "required": false, "type": "uuid" }, { - "description": "the staging store protocol", - "length": 255, - "name": "protocol", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", + "description": "the name of the staging store", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, @@ -8651,6 +8637,13 @@ "required": false, "type": "string" }, + { + "description": "the staging store protocol", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -8659,36 +8652,38 @@ "type": "integer" }, { - "description": "the ID of the staging store", + "description": "the Zone ID for the staging store", "length": 255, - "name": "id", - "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "response": [ - { - "description": "the name of the image store", - "name": "name", - "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" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" }, { "description": "the host's currently used disk size", @@ -8696,44 +8691,49 @@ "type": "long" }, { - "description": "the Zone name of the image store", - "name": "zonename", - "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 protocol of the image store", - "name": "protocol", - "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 total disk size of the host", "name": "disksizetotal", "type": "long" }, + { + "description": "the Zone name of the image store", + "name": "zonename", + "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 Zone ID of the image store", - "name": "zoneid", + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, + { + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { @@ -8761,18 +8761,181 @@ "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the gateway for the router", - "name": "gateway", + "description": "VPC the router belongs to", + "name": "vpcid", "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", + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the ip address of the nic", + "name": "ipaddress", + "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 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": "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "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": "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": "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 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", + "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": "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": "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 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": "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { @@ -8781,38 +8944,48 @@ "type": "state" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the router", - "name": "name", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "role of the domain router", + "name": "role", "type": "string" }, { @@ -8821,18 +8994,45 @@ "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "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 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 public netmask for the router", - "name": "publicnetmask", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { @@ -8841,16 +9041,15 @@ "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, - {}, { "description": "the link local IP address for the router", "name": "linklocalip", @@ -8862,24 +9061,24 @@ "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the domain ID associated with the router", - "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 service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the gateway for the router", + "name": "gateway", "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", + "type": "string" }, { "description": "the guest IP address for the router", @@ -8887,255 +9086,93 @@ "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the Pod name for the router", + "name": "podname", "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 Pod name for the router", - "name": "podname", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "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": "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": "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 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": "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": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "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 gateway of the nic", - "name": "gateway", - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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 ip address of the nic", - "name": "ipaddress", - "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": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { @@ -9144,86 +9181,49 @@ "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, + {}, { - "description": "the template name for the router", - "name": "templatename", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "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": "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": "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 link local netmask for the router", "name": "linklocalnetmask", "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "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", + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", "type": "string" } ] @@ -9234,26 +9234,10 @@ "name": "resetConfiguration", "params": [ { - "description": "the ID of the Image Store to reset the parameter value for corresponding image store", - "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", + "description": "the ID of the Account to reset the parameter value for corresponding account", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, @@ -9273,6 +9257,14 @@ "required": false, "type": "uuid" }, + { + "description": "the ID of the Image Store to reset the parameter value for corresponding image store", + "length": 255, + "name": "imagestoreid", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "required": false, + "type": "uuid" + }, { "description": "the name of the configuration", "length": 255, @@ -9281,40 +9273,32 @@ "type": "string" }, { - "description": "the ID of the Account to reset the parameter value for corresponding account", + "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" } ], "related": "listConfigurations,updateConfiguration", "response": [ - { - "description": "the name of the configuration", - "name": "name", - "type": "string" - }, - { - "description": "the default value of the configuration", - "name": "defaultvalue", - "type": "string" - }, { "description": "the component of the configuration", "name": "component", "type": "string" }, { - "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": "the type of the configuration value", + "name": "type", "type": "string" }, { @@ -9323,43 +9307,55 @@ "type": "string" }, { - "description": "the group of the configuration", - "name": "group", - "type": "string" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the default value of the configuration", + "name": "defaultvalue", "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": "the possible options of the configuration value", "name": "options", "type": "string" }, + { + "description": "the value of the configuration", + "name": "value", + "type": "string" + }, + {}, { "description": "the category of the configuration", "name": "category", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the configuration", + "name": "description", "type": "string" }, + {}, { - "description": "the type of the configuration value", - "name": "type", + "description": "the value of the configuration", + "name": "id", + "type": "long" + }, + { + "description": "the group of the configuration", + "name": "group", "type": "string" }, { @@ -9368,14 +9364,18 @@ "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the subgroup of the configuration", + "name": "subgroup", + "type": "string" }, - {}, { - "description": "the value of the configuration", - "name": "value", + "description": "the display text of the configuration", + "name": "displaytext", + "type": "string" + }, + { + "description": "the name of the configuration", + "name": "name", "type": "string" } ], @@ -9386,13 +9386,6 @@ "isasync": true, "name": "createAutoScalePolicy", "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 action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, @@ -9401,12 +9394,12 @@ "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "the name of the autoscale policy", "length": 255, - "name": "conditionids", - "related": "createCondition,listConditions", - "required": true, - "type": "list" + "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", @@ -9416,29 +9409,36 @@ "type": "integer" }, { - "description": "the name of the autoscale policy", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "name", + "name": "quiettime", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" + }, + { + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "length": 255, + "name": "conditionids", + "related": "createCondition,listConditions", + "required": true, + "type": "list" } ], "related": "listAutoScalePolicies,updateAutoScalePolicy", "response": [ - { - "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 list of IDs of the conditions that are being evaluated on every interval", "name": "conditions", "type": "list" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the domain name of the autoscale policy", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, { @@ -9451,15 +9451,14 @@ "name": "id", "type": "string" }, - {}, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -9467,35 +9466,36 @@ "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "the account owning the autoscale policy", + "name": "account", + "type": "string" + }, { "description": "the duration for which the conditions have to be true before action is taken", "name": "duration", "type": "integer" }, - {}, { - "description": "name of the autoscale policy", - "name": "name", - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the autoscale policy", + "name": "name", "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 domain name of the autoscale policy", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" } ] @@ -9509,7 +9509,7 @@ "description": "the host ID of ssp server", "length": 255, "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } @@ -9521,22 +9521,22 @@ "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" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -9546,23 +9546,6 @@ "params": [], "related": "", "response": [ - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" - }, - { - "description": "the last time a usage job successfully completed", - "name": "lastsuccessfuljob", - "type": "date" - }, { "description": "the last time this Usage Server checked for jobs", "name": "lastheartbeat", @@ -9573,6 +9556,16 @@ "name": "hostname", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" + }, { "description": "the state of the usage server", "name": "state", @@ -9582,6 +9575,13 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + {}, + { + "description": "the last time a usage job successfully completed", + "name": "lastsuccessfuljob", + "type": "date" } ], "since": "4.17.0" @@ -9601,11 +9601,10 @@ } ], "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", @@ -9613,16 +9612,17 @@ "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.11" }, @@ -9633,9 +9633,9 @@ "params": [], "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", @@ -9643,109 +9643,184 @@ "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Updates Routing firewall rule with specified ID", - "isasync": true, - "name": "updateRoutingFirewallRule", + "description": "Lists object storage pools.", + "isasync": false, + "name": "listObjectStoragePools", "params": [ { - "description": "an optional field, whether to the display the Routing firewall rule to the end user or not", + "description": "the object store provider", "length": 255, - "name": "fordisplay", + "name": "provider", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the Routing firewall rule", + "description": "", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" + "name": "page", + "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": "List by keyword", "length": 255, - "name": "customid", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the name of the object store", + "length": 255, + "name": "name", "required": false, - "since": "4.4", "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the storage pool", + "length": 255, + "name": "id", + "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", + "required": false, + "type": "uuid" } ], - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "addObjectStoragePool,updateObjectStoragePool", "response": [ + {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the ID of the object store", + "name": "id", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the url of the object store", + "name": "url", "type": "string" }, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "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", - "type": "string" + "description": "the total size of the object store", + "name": "storagetotal", + "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 object store currently used size", + "name": "storageused", + "type": "long" }, { - "description": "the state of the rule", - "name": "state", + "description": "the name of the object store", + "name": "name", "type": "string" }, + {}, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "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 network the port forwarding rule belongs to", - "name": "networkid", + "description": "the provider name of the object store", + "name": "providername", "type": "string" }, { - "description": "is firewall for display to the regular user", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + } + ], + "since": "4.19.0" + }, + { + "description": "Updates Routing firewall rule with specified ID", + "isasync": true, + "name": "updateRoutingFirewallRule", + "params": [ + { + "description": "the ID of the Routing firewall rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + }, + { + "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": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "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": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "response": [ + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "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" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "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" }, { @@ -9754,18 +9829,18 @@ "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { @@ -9773,38 +9848,33 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", - "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 value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "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": "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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -9818,132 +9888,62 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "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" - } - ], - "since": "4.20.0" - }, - { - "description": "Lists object storage pools.", - "isasync": false, - "name": "listObjectStoragePools", - "params": [ - { - "description": "the ID of the storage pool", - "length": 255, - "name": "id", - "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { - "description": "the name of the object store", - "length": 255, - "name": "name", - "required": false, + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the object store provider", - "length": 255, - "name": "provider", - "required": false, + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "addObjectStoragePool,updateObjectStoragePool", - "response": [ {}, { - "description": "the provider name of the object store", - "name": "providername", - "type": "string" - }, - { - "description": "the name of the object store", - "name": "name", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is firewall 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 url of the object store", - "name": "url", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "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 ID of the object store", - "name": "id", + "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 id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" - } + }, + {} ], - "since": "4.19.0" + "since": "4.20.0" }, { "description": "create secondary staging store.", @@ -9951,19 +9951,18 @@ "name": "createSecondaryStagingStore", "params": [ { - "description": "the scope of the staging store: zone only for now", - "length": 255, - "name": "scope", - "required": false, + "description": "the URL for the staging store", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { - "description": "the Zone ID for the staging store", + "description": "the scope of the staging store: zone only for now", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "scope", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the staging store provider name", @@ -9980,87 +9979,88 @@ "type": "map" }, { - "description": "the URL for the staging store", - "length": 2048, - "name": "url", - "required": true, - "type": "string" + "description": "the Zone ID for the staging store", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" } ], "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ - { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, + {}, { "description": "the protocol of the image store", "name": "protocol", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the ID of the image store", + "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", - "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", "type": "long" }, + { + "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 provider name of the image store", "name": "providername", "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 of the image store", - "name": "zoneid", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { "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 scope of the image store", + "name": "scope", + "type": "scopetype" }, { "description": "defines if store is read-only", "name": "readonly", "type": "boolean" }, - {} + { + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + } ] }, { @@ -10078,9 +10078,10 @@ } ], "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" }, { @@ -10093,13 +10094,12 @@ "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" - } + }, + {} ] }, { @@ -10107,6 +10107,14 @@ "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": "ID of load balancer health check policy", "length": 255, @@ -10122,62 +10130,74 @@ "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": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "response": [ + {}, { "description": "the id of the zone the HealthCheck policy belongs to", "name": "zoneid", "type": "string" }, + {}, { "description": "the LB rule ID", "name": "lbruleid", "type": "string" }, - {}, { "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", + "type": "string" + }, { "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": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the state of the policy", "name": "state", "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" + }, + { + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", "type": "int" }, { @@ -10186,9 +10206,9 @@ "type": "int" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" }, { "description": "the description of the healthcheck policy", @@ -10196,32 +10216,12 @@ "type": "string" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", "type": "int" - }, - { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" - }, - { - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.4" @@ -10231,13 +10231,6 @@ "isasync": true, "name": "removeTungstenFabricPolicyRule", "params": [ - { - "description": "the Uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -10246,6 +10239,13 @@ "required": true, "type": "uuid" }, + { + "description": "the Uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" + }, { "description": "the Uuid of Tungsten-Fabric policy rule", "length": 255, @@ -10256,22 +10256,21 @@ ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy,removeTungstenFabricPolicy", "response": [ + {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "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": "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 policy name", @@ -10279,19 +10278,20 @@ "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 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 tag type uuid", + "name": "uuid", + "type": "string" }, {} ] @@ -10302,48 +10302,42 @@ "name": "createLoadBalancerRule", "params": [ { - "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": "an optional field, whether to the display the rule to the end user or not", + "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", "length": 255, - "name": "fordisplay", + "name": "protocol", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", + "description": "public IP address ID from where the network traffic will be load balanced from", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "publicipid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "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", + "description": "the domain ID associated with the load balancer", "length": 255, - "name": "openfirewall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "the public port from where the network traffic will be load balanced from", "length": 255, - "name": "algorithm", + "name": "publicport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "name of the load balancer rule", + "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": "name", - "required": true, - "type": "string" + "name": "cidrlist", + "required": false, + "since": "4.18.0.0", + "type": "list" }, { "description": "the description of the load balancer rule", @@ -10353,17 +10347,18 @@ "type": "string" }, { - "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "protocol", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "public IP address ID from where the network traffic will be load balanced from", + "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": "publicipid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, @@ -10375,52 +10370,57 @@ "type": "string" }, { - "description": "the public port from where the network traffic will be load balanced from", + "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", "length": 255, - "name": "publicport", - "required": true, - "type": "integer" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "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)", + "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": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "openfirewall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the domain ID associated with the load balancer", + "description": "name of the load balancer rule", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "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 (,). By default, all CIDRs are allowed.", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "cidrlist", - "required": false, - "since": "4.18.0.0", - "type": "list" + "name": "algorithm", + "required": true, + "type": "string" + }, + { + "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" } ], "related": "listLoadBalancerRules,updateLoadBalancerRule", "response": [ { - "description": "the public ip address", - "name": "publicip", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { @@ -10428,37 +10428,12 @@ "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 public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "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", @@ -10466,13 +10441,8 @@ }, {}, { - "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 account of the load balancer rule", + "name": "account", "type": "string" }, { @@ -10485,66 +10455,66 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "resource type", - "name": "resourcetype", + "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 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 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" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the public port", + "name": "publicport", "type": "string" }, { @@ -10558,13 +10528,23 @@ "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "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": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", "type": "string" }, { @@ -10573,19 +10553,39 @@ "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "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 load balancer rule ID", "name": "id", "type": "string" }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the load balancer algorithm (source, roundrobin, leastconn)", "name": "algorithm", "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" } ] }, @@ -10606,32 +10606,32 @@ "related": "quotaConfigureEmail", "response": [ { - "description": "The template's name.", - "name": "templatename", - "type": "string" + "description": "Whether the template is enabled.", + "name": "enabled", + "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The configured account's id.", + "name": "account", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "The configured account's id.", - "name": "account", + "description": "The template's name.", + "name": "templatename", "type": "string" }, { - "description": "Whether the template is enabled.", - "name": "enabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "The configured account's min balance.", "name": "minbalance", @@ -10661,36 +10661,36 @@ "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 Storage Policy", "name": "description", "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 Policy", + "name": "name", + "type": "string" }, + {}, + {}, { "description": "the ID of the Storage Policy", "name": "id", "type": "string" }, - { - "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 name of the Storage Policy", - "name": "name", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" } ] @@ -10712,9 +10712,9 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ { - "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", + "type": "string" }, { "description": "the ID of the host", @@ -10722,24 +10722,9 @@ "type": "string" }, { - "description": "the operation result description", - "name": "description", - "type": "string" - }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "the out-of-band management interface address", - "name": "address", - "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 UUID of the latest async job acting on this object", @@ -10747,21 +10732,17 @@ "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - {}, - { - "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 action (if issued)", - "name": "action", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, + {}, + {}, { "description": "true if out-of-band management is enabled for the host", "name": "enabled", @@ -10773,349 +10754,174 @@ "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - {} - ], - "since": "4.9.0" - }, - { - "description": "Lists all IPv6 firewall rules", - "isasync": false, - "name": "listIpv6FirewallRules", - "params": [ - { - "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 ipv6 firewall rules by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", - "required": false, + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the out-of-band management interface port", + "name": "port", + "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 operation result", + "name": "status", "type": "boolean" }, { - "description": "Lists ipv6 firewall rule with the specified ID", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": false, - "type": "uuid" - }, - { - "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": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list ipv6 firewall rules by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" - }, + } + ], + "since": "4.9.0" + }, + { + "description": "Stops a system VM.", + "isasync": true, + "name": "stopSystemVm", + "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "The ID of the system virtual machine", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": false, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", + "required": true, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", + "name": "forced", "required": false, "type": "boolean" } ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "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 date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the Pod ID for the system VM", + "name": "podid", "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": "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": "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" - }, - { - "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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "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 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 ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "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" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "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", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "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 second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" - } - ] - }, - { - "description": "Stops a system VM.", - "isasync": true, - "name": "stopSystemVm", - "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 system virtual machine", - "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", - "required": true, - "type": "uuid" - } - ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "response": [ - { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", - "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 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 date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { @@ -11124,23 +10930,8 @@ "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" - }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { @@ -11148,64 +10939,19 @@ "name": "isdynamicallyscalable", "type": "boolean" }, - { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" - }, - { - "description": "the network domain for the system VM", - "name": "networkdomain", - "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 IP address for the system VM", "name": "privateip", "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 state of the system VM", - "name": "state", - "type": "string" - }, - { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" - }, - { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { @@ -11214,65 +10960,60 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, - {}, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the state of the system VM", + "name": "state", "type": "string" }, {}, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" - }, - { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, + {}, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" } ] @@ -11286,14 +11027,17 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "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", @@ -11304,16 +11048,13 @@ "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" - } + {} ] }, { @@ -11322,34 +11063,33 @@ "name": "updateVPC", "params": [ { - "description": "the display text of the VPC", + "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": "displaytext", + "name": "sourcenatipaddress", "required": false, + "since": "4.19", "type": "string" }, { - "description": "an optional field, whether to the display the vpc to the end user or not", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "fordisplay", + "name": "publicmtu", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.18.0", + "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the name of the VPC", "length": 255, - "name": "customid", + "name": "name", "required": false, - "since": "4.4", "type": "string" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC", + "description": "the display text of the VPC", "length": 255, - "name": "sourcenatipaddress", + "name": "displaytext", "required": false, - "since": "4.19", "type": "string" }, { @@ -11361,90 +11101,29 @@ "type": "uuid" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "publicmtu", + "name": "fordisplay", "required": false, - "since": "4.18.0", - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "the name of the VPC", + "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", + "name": "customid", "required": false, + "since": "4.4", "type": "string" } ], "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "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 BGP peers for the VPC", - "name": "bgppeers", - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, - {}, - {}, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, - { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "description": "true VPC requires restart", + "name": "restartrequired", "type": "boolean" }, - { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", @@ -11456,63 +11135,43 @@ "type": "long" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the project name of the VPC", - "name": "project", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the name of the VPC", - "name": "name", - "type": "string" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "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": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, { "description": "the capability name", "name": "name", @@ -11521,11 +11180,6 @@ ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", @@ -11535,14 +11189,24 @@ "name": "id", "type": "string" }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "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", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -11550,20 +11214,10 @@ "name": "servicelist", "type": "list" }, - { - "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 destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" } ], "type": "list" @@ -11571,6 +11225,21 @@ ], "type": "list" }, + { + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, { "description": "the id of the VPC", "name": "id", @@ -11581,48 +11250,48 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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": "customer associated with the tag", + "name": "customer", "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": "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", + "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" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -11631,17 +11300,18 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, + {}, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" }, { "description": "true if VPC is region level", @@ -11649,9 +11319,29 @@ "type": "boolean" }, { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", + "type": "string" + }, + { + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" }, { "description": "the name of the zone the VPC belongs to", @@ -11659,62 +11349,128 @@ "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the cidr the VPC", + "name": "cidr", + "type": "string" + }, + { + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" + }, + { + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" + }, + { + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" }, { "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", "name": "distributedvpcrouter", "type": "boolean" }, + { + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + }, { "description": "UUID of AS NUMBER", "name": "asnumberid", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", - "type": "string" + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" } ] }, { - "description": "List VM Schedules.", + "description": "Lists all IPv6 firewall rules", "isasync": false, - "name": "listVMSchedule", + "name": "listIpv6FirewallRules", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "Lists ipv6 firewall rule with the specified ID", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -11723,28 +11479,272 @@ "type": "integer" }, { - "description": "ID of VM schedule", + "description": "", "length": 255, - "name": "enabled", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "required": false, + "type": "string" + }, + { + "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": "ID of VM schedule", + "description": "list ipv6 firewall rules by network ID", "length": 255, - "name": "id", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "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 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": "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": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "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" + } + ], + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "response": [ + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "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 VM ID for the port forwarding rule", + "name": "virtualmachineid", + "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 VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "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": "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": "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 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" + } + ], + "type": "list" + }, + { + "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 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": "List VM Schedules.", + "isasync": false, + "name": "listVMSchedule", + "params": [ { "description": "ID of the VM for which schedule is to be defined", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, + { + "description": "ID of VM schedule", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "ID of VM schedule", + "length": 255, + "name": "id", + "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -11770,8 +11770,23 @@ "related": "createVMSchedule,updateVMSchedule", "response": [ { - "description": "Timezone of the schedule", - "name": "timezone", + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + }, + { + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, + { + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -11794,43 +11809,28 @@ "name": "virtualmachineid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the ID of VM schedule", "name": "id", "type": "string" }, + {}, + {}, { "description": "Cron formatted VM schedule", "name": "schedule", "type": "string" }, { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" - }, - { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" - }, - {}, - {} + } ], "since": "4.19.0" }, @@ -11856,12 +11856,6 @@ } ], "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", @@ -11869,15 +11863,21 @@ }, {}, { - "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ], "since": "4.17.0" }, @@ -11887,51 +11887,40 @@ "name": "listVolumesMetrics", "params": [ { - "description": "the type of disk volume", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the IDs of the volumes, mutually exclusive with id", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "ids", - "related": "importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "displayvolume", "required": false, - "since": "4.9", - "type": "list" + "since": "4.4", + "type": "boolean" }, { - "description": "list volumes on specified host", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "retrieveonlyresourcecount", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the cluster id the disk volume belongs to", + "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, available to ROOT admin only", @@ -11943,202 +11932,213 @@ "type": "string" }, { - "description": "the ID of the disk volume", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "id", - "related": "importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "podid", + "related": "createPod,listPods,updatePod,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.", + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "listsystemvms", "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list volumes on specified host", "length": 255, - "name": "isrecursive", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the ID of the availability zone", + "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "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, - "type": "uuid" + "since": "4.9", + "type": "list" }, { - "description": "the pod id the disk volume belongs to", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "list volumes by disk offering", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "name", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "page", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "list only volumes that are encrypted", "length": 255, - "name": "pagesize", + "name": "isencrypted", "required": false, - "type": "integer" + "since": "4.19.1", + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the name of the disk volume", "length": 255, - "name": "displayvolume", + "name": "name", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "the type of disk volume", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the disk volume", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "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": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the availability zone", "length": 255, - "name": "listsystemvms", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.18", - "type": "boolean" + "type": "uuid" }, { - "description": "list only volumes that are encrypted", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isencrypted", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "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": "boolean" + "type": "uuid" }, { - "description": "list volumes by disk offering", + "description": "the ID of the virtual machine", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "state", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", + "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": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "listall", "required": false, - "since": "4.19.1", - "type": "uuid" + "type": "boolean" } ], "related": "", "response": [ { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "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": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { "description": "the state of the disk volume", @@ -12146,58 +12146,74 @@ "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "disk size in GiB", + "name": "sizegb", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "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": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the path of the volume", + "name": "path", + "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": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { @@ -12205,34 +12221,39 @@ "name": "encryptformat", "type": "string" }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, { "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": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { @@ -12240,289 +12261,268 @@ "name": "diskBytesWriteRate", "type": "long" }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, { "description": "volume uuid that is given by virtualisation provider (only for VMware)", "name": "externaluuid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "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", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "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": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", "type": "map" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "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": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, - {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, + { + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "disk size in GiB", - "name": "sizegb", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "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": "name of the virtual machine", - "name": "vmname", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, {}, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "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": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, { "description": "path of the Domain the disk volume belongs to", "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the total disk iops", - "name": "diskiopstotal", - "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": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "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": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" } ], "since": "4.9.3" @@ -12533,24 +12533,22 @@ "name": "listDetailOptions", "params": [ { - "description": "the resource type such as UserVm, Template etc.", + "description": "the UUID of the resource (optional)", "length": 255, - "name": "resourcetype", - "required": true, + "name": "resourceid", + "required": false, "type": "string" }, { - "description": "the UUID of the resource (optional)", + "description": "the resource type such as UserVm, Template etc.", "length": 255, - "name": "resourceid", - "required": false, + "name": "resourcetype", + "required": true, "type": "string" } ], "related": "", "response": [ - {}, - {}, { "description": "Map of all possible details and their possible list of values", "name": "details", @@ -12565,7 +12563,9 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {}, + {} ], "since": "4.13" }, @@ -12574,6 +12574,14 @@ "isasync": false, "name": "listSslCerts", "params": [ + { + "description": "ID of SSL certificate", + "length": 255, + "name": "certid", + "related": "uploadSslCert,listSslCerts", + "required": false, + "type": "uuid" + }, { "description": "Account ID", "length": 255, @@ -12583,10 +12591,10 @@ "type": "uuid" }, { - "description": "ID of SSL certificate", + "description": "Load balancer rule ID", "length": 255, - "name": "certid", - "related": "uploadSslCert,listSslCerts", + "name": "lbruleid", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": false, "type": "uuid" }, @@ -12597,26 +12605,18 @@ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" - }, - { - "description": "Load balancer rule ID", - "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": false, - "type": "uuid" } ], "related": "uploadSslCert", "response": [ { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, { - "description": "SSL certificate ID", - "name": "id", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, { @@ -12625,18 +12625,14 @@ "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "certificate chain", - "name": "certchain", - "type": "string" + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" }, + {}, { - "description": "name", - "name": "name", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, { @@ -12644,37 +12640,41 @@ "name": "project", "type": "string" }, + {}, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "account for the certificate", + "name": "account", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "certificate chain", + "name": "certchain", "type": "string" }, { - "description": "account for the certificate", - "name": "account", + "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": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "name", + "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", + "type": "string" } ] }, @@ -12684,9 +12684,9 @@ "name": "listPrivateGateways", "params": [ { - "description": "list gateways by vlan", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "vlan", + "name": "account", "required": false, "type": "string" }, @@ -12699,12 +12699,11 @@ "type": "uuid" }, { - "description": "list private gateway by id", + "description": "list gateways by ip address", "length": 255, - "name": "id", - "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", + "name": "ipaddress", "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.", @@ -12716,28 +12715,14 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, - { - "description": "list gateways by ip address", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -12750,9 +12735,9 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list gateways by state", "length": 255, - "name": "account", + "name": "state", "required": false, "type": "string" }, @@ -12763,6 +12748,13 @@ "required": false, "type": "boolean" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -12772,9 +12764,17 @@ "type": "uuid" }, { - "description": "list gateways by state", + "description": "list private gateway by id", "length": 255, - "name": "state", + "name": "id", + "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", + "required": false, + "type": "uuid" + }, + { + "description": "list gateways by vlan", + "length": 255, + "name": "vlan", "required": false, "type": "string" } @@ -12782,45 +12782,49 @@ "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "response": [ { - "description": "the project name of the private gateway", - "name": "project", + "description": "path of the domain to which the private gateway belongs", + "name": "domainpath", "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 domain associated with the private gateway", - "name": "domain", + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { - "description": "Source Nat enable status", - "name": "sourcenatsupported", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, {}, - {}, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { @@ -12829,48 +12833,49 @@ "type": "string" }, { - "description": "path of the domain to which the private gateway belongs", - "name": "domainpath", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, + {}, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project name of the private gateway", + "name": "project", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network implementation uri for the private gateway", + "name": "vlan", + "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { @@ -12879,33 +12884,28 @@ "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", - "type": "string" - }, - { - "description": "the gateway", - "name": "gateway", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway", + "name": "gateway", "type": "string" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" } ] @@ -12915,6 +12915,13 @@ "isasync": true, "name": "updateVmNicIp", "params": [ + { + "description": "Secondary IP Address", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, { "description": "the ID of the nic to which you want to assign private IP", "length": 255, @@ -12922,331 +12929,477 @@ "related": "listNics", "required": true, "type": "uuid" - }, - { - "description": "Secondary IP Address", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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 project name of the vm", - "name": "project", - "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 domain in which the virtual machine exists", - "name": "domainid", - "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": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "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": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "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", - "name": "account", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "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": "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" + }, + { + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "tag key name", - "name": "key", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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": "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 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 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": "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": "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": "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "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" + }, + { + "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": "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 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": "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": "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": "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, - {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "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", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - {}, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "User VM type", - "name": "vmtype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, { "description": "the ID of the availability zone for the virtual machine", "name": "zoneid", "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 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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, { "description": "the ID of the backup offering of the virtual machine", "name": "backupofferingid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "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": "User VM type", + "name": "vmtype", + "type": "string" }, { "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", @@ -13254,230 +13407,170 @@ "type": "long" }, { - "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", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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", + "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project name of the affinity group", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "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 list of nics associated with vm", "name": "nic", "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "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" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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 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", + "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", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the IPv6 address of network", @@ -13485,68 +13578,23 @@ "type": "string" }, { - "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": "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 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 isolated private VLAN type if available", + "name": "isolatedpvlantype", "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": "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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "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", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -13555,464 +13603,162 @@ "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": "the netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { "description": "the cidr of IPv6 network", "name": "ip6cidr", "type": "string" - } - ], - "type": "set" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "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 domain name of the security group", - "name": "domain", + "description": "the netmask of the nic", + "name": "netmask", "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": "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": "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": "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" - } - ], - "type": "set" + "description": "the name of the corresponding network", + "name": "networkname", + "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 code for the ICMP message response", - "name": "icmpcode", - "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 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 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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "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": "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 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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the 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 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": "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" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the ID of the security group", + "description": "the ID of the nic", "name": "id", "type": "string" } ], "type": "set" }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, { "description": "VNF details", "name": "vnfdetails", "type": "map" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "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 template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "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": "the ID of the virtual machine", - "name": "id", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "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 type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "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 date when this virtual machine was created", @@ -14020,348 +13766,558 @@ "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": "Starts an existing internal lb vm.", - "isasync": true, - "name": "startInternalLoadBalancerVM", - "params": [ - { - "description": "the ID of the internal lb vm", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "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 template ID for the router", - "name": "templateid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "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 control state of the host for the router", - "name": "hostcontrolstate", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, - {}, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, + {}, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "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": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the type of the affinity group", + "name": "type", + "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 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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "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 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", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "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 amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "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": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, + {}, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + } + ] + }, + { + "description": "Starts an existing internal lb vm.", + "isasync": true, + "name": "startInternalLoadBalancerVM", + "params": [ + { + "description": "the ID of the internal lb vm", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ { "description": "the version of template", "name": "version", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, + {}, { - "description": "the project name of the address", - "name": "project", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "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", + "type": "boolean" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "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", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the Zone ID for the router", + "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 address", + "name": "project", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + {}, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "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 name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "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", + "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 gateway of the nic", - "name": "gateway", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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 cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -14370,19 +14326,19 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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": "device id for the network when plugged into the virtual machine", @@ -14390,14 +14346,14 @@ "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ID of the corresponding network", + "name": "networkid", "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 isolation uri of the nic", @@ -14405,53 +14361,48 @@ "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", + "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 netmask of the nic", - "name": "netmask", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -14460,52 +14411,101 @@ "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "type": "set" }, + { + "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 ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, { "description": "the link local MAC address for the router", "name": "linklocalmacaddress", "type": "string" }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, { "description": "the account associated with the router", "name": "account", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, - {}, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" } ] @@ -14515,6 +14515,22 @@ "isasync": false, "name": "updateDiskOffering", "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": "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": "length (in seconds) of the burst", "length": 255, @@ -14524,59 +14540,58 @@ "type": "long" }, { - "description": "io requests write rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopswriterate", + "name": "iopswriteratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "tags", + "name": "bytesreadrate", "required": false, "since": "4.15", - "type": "string" + "type": "long" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", + "description": "updates alternate display text of the disk offering with this value", + "length": 4096, + "name": "displaytext", "required": false, - "since": "4.13", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "byteswriteratemax", + "name": "bytesreadratemax", "required": false, "since": "4.15", "type": "long" }, { - "description": "the cache mode to use for this disk offering", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "cachemode", + "name": "byteswriterate", "required": false, "since": "4.15", - "type": "string" + "type": "long" }, { - "description": "state of the disk offering", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "state", + "name": "byteswriteratemax", "required": false, - "type": "string" + "since": "4.15", + "type": "long" }, { - "description": "ID of the disk offering", + "description": "sort key of the disk offering, integer", "length": 255, - "name": "id", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" + "name": "sortkey", + "required": false, + "type": "integer" }, { "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", @@ -14587,25 +14602,24 @@ "type": "string" }, { - "description": "burst requests read rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopsreadratemax", + "name": "iopsreadratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "bytes write rate of the disk offering", + "description": "state of the disk offering", "length": 255, - "name": "byteswriterate", + "name": "state", "required": false, - "since": "4.15", - "type": "long" + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "bytesreadratemax", + "name": "iopswriterate", "required": false, "since": "4.15", "type": "long" @@ -14613,17 +14627,18 @@ { "description": "length (in seconds) of the burst", "length": 255, - "name": "iopswriteratemaxlength", + "name": "byteswriteratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "displayoffering", + "name": "iopswriteratemax", "required": false, - "type": "boolean" + "since": "4.15", + "type": "long" }, { "description": "updates name of the disk offering with this value", @@ -14633,35 +14648,35 @@ "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "iopsreadratemax", "required": false, "since": "4.15", "type": "long" }, { - "description": "sort key of the disk offering, integer", + "description": "ID of the disk offering", "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" + "name": "id", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" }, { - "description": "length (in seconds) of the burst", + "description": "the cache mode to use for this disk offering", "length": 255, - "name": "byteswriteratemaxlength", + "name": "cachemode", "required": false, "since": "4.15", - "type": "long" + "type": "string" }, { - "description": "bytes read rate of the disk offering", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "bytesreadrate", + "name": "displayoffering", "required": false, - "since": "4.15", - "type": "long" + "type": "boolean" }, { "description": "io requests read rate of the disk offering", @@ -14670,84 +14685,74 @@ "required": false, "since": "4.15", "type": "long" - }, - { - "description": "updates alternate display text of the disk offering with this value", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "burst io requests write rate of the disk offering", - "length": 255, - "name": "iopswriteratemax", - "required": false, - "since": "4.15", - "type": "long" } ], "related": "createDiskOffering,listDiskOfferings", "response": [ { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "io requests write rate of 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": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, - {}, { - "description": "state of the disk offering", - "name": "state", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, + {}, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", "type": "boolean" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "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 date this disk offering was created", - "name": "created", - "type": "date" + "description": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { @@ -14756,49 +14761,49 @@ "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": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, { "description": "the name of the disk offering", "name": "name", "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "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": "unique ID of the disk offering", - "name": "id", - "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": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "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": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", @@ -14806,9 +14811,9 @@ "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { "description": "additional key/value details tied with this disk offering", @@ -14816,15 +14821,14 @@ "type": "map" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, - {}, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { "description": "true if disk offering uses custom size, false otherwise", @@ -14832,64 +14836,60 @@ "type": "boolean" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" - }, - { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "the size of the disk offering in GB", + "name": "disksize", "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": "true if disk offering uses custom iops, false otherwise", "name": "iscustomizediops", "type": "boolean" }, { - "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": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, + {}, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "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": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "state of the disk offering", + "name": "state", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -14898,6 +14898,14 @@ "isasync": false, "name": "removeVirtualMachinesFromKubernetesCluster", "params": [ + { + "description": "the IDs of the VMs to remove from the cluster", + "length": 255, + "name": "virtualmachineids", + "related": "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 ID of the Kubernetes cluster", "length": 255, @@ -14907,11 +14915,11 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -14921,33 +14929,25 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" - }, - { - "description": "the IDs of the VMs to remove from the cluster", - "length": 255, - "name": "virtualmachineids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": true, - "type": "list" + "type": "integer" } ], "related": "", "response": [ - { - "description": "the id of the Kubernetes cluster", - "name": "id", - "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", @@ -14959,12 +14959,12 @@ "name": "displaytext", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" + } ], "since": "4.19.0" }, @@ -14990,27 +14990,27 @@ } ], "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 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" } ] }, @@ -15019,14 +15019,6 @@ "isasync": true, "name": "resetVpnConnection", "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.", "length": 255, @@ -15035,6 +15027,14 @@ "required": false, "type": "uuid" }, + { + "description": "id of vpn connection", + "length": 255, + "name": "id", + "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", + "required": true, + "type": "uuid" + }, { "description": "an optional account for connection. Must be used with domainId.", "length": 255, @@ -15045,19 +15045,26 @@ ], "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "response": [ + {}, + {}, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { @@ -15066,43 +15073,43 @@ "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, { "description": "Lifetime of IKE SA of customer gateway", "name": "ikelifetime", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "State of vpn connection", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the connection ID", + "name": "id", "type": "string" }, { @@ -15110,21 +15117,24 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, - {}, { - "description": "the connection ID", - "name": "id", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { @@ -15133,14 +15143,14 @@ "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" }, { "description": "if DPD is enabled for customer gateway", @@ -15148,33 +15158,18 @@ "type": "boolean" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { @@ -15183,8 +15178,13 @@ "type": "boolean" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" } ] @@ -15195,11 +15195,11 @@ "name": "listKubernetesClusters", "params": [ { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -15209,41 +15209,42 @@ "type": "boolean" }, { - "description": "state of the Kubernetes cluster", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "state", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "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 objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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": "the ID of the Kubernetes cluster", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "", "length": 255, - "name": "clustertype", + "name": "page", "required": false, - "since": "4.19.0", - "type": "string" + "type": "integer" }, { "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", @@ -15253,98 +15254,83 @@ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "state of the Kubernetes cluster", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain 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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "clustertype", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "string" } ], "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ - { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" - }, { "description": "the ID of the template of the Kubernetes cluster", "name": "templateid", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" - }, - { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, + {}, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, + {}, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" }, - {}, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { "description": "the name of the Kubernetes version for the Kubernetes cluster", @@ -15352,43 +15338,48 @@ "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, - { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, { "description": "the project id of the Kubernetes cluster", "name": "projectid", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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 name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { @@ -15397,8 +15388,18 @@ "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { @@ -15407,34 +15408,28 @@ "type": "boolean" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -15443,39 +15438,44 @@ "type": "long" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "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", + "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" + }, + { + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" } ] }, @@ -15485,27 +15485,28 @@ "name": "createAutoScaleVmGroup", "params": [ { - "description": "the frequency in which the performance counters to be collected", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "interval", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" }, { - "description": "list of scaleup autoscale policies", + "description": "the autoscale profile that contains information about the vms in the vm group.", "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", "required": true, - "type": "list" + "type": "uuid" }, { "description": "the name of the autoscale vmgroup", @@ -15516,9 +15517,9 @@ "type": "string" }, { - "description": "list of scaledown autoscale policies", + "description": "list of scaleup autoscale policies", "length": 255, - "name": "scaledownpolicyids", + "name": "scaleuppolicyids", "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, "type": "list" @@ -15531,157 +15532,151 @@ "type": "integer" }, { - "description": "an optional field, whether to the display the group to the end user or not", + "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": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "maxmembers", + "required": true, + "type": "integer" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", + "description": "the frequency in which the performance counters to be collected", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" + "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.", + "description": "list of scaledown autoscale policies", "length": 255, - "name": "maxmembers", + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, - "type": "integer" + "type": "list" } ], "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the autoscale vm group ", - "name": "name", + "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": "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", - "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 id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the account owning the vm group", - "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": "the domain ID of the vm group", - "name": "domainid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the domain name of the vm group", + "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": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the load balancer rule ID", + "name": "lbruleid", "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 public port", - "name": "publicport", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "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", + "name": "jobid", + "type": "string" }, - {}, { "description": "list of scaleup autoscale policies", "name": "scaleuppolicies", "type": "list" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the public port", + "name": "publicport", + "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 private port", + "name": "privateport", + "type": "string" }, + {}, { - "description": "the project name of the vm group", - "name": "project", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, + {}, { "description": "path of the domain to which the vm group belongs", "name": "domainpath", "type": "string" }, - {}, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + { + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { "description": "is group for display to the regular user", @@ -15689,35 +15684,71 @@ "type": "boolean" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", - "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", + "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 name of the autoscale vm group ", + "name": "name", "type": "string" } ] }, { - "description": "Change the BGP peers for a VPC.", + "description": "Deletes a load balancer rule.", "isasync": true, - "name": "changeBgpPeersForVpc", + "name": "deleteLoadBalancerRule", "params": [ { - "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", + "description": "the ID of the load balancer rule", "length": 255, - "name": "bgppeerids", - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", - "required": false, - "type": "list" + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Change the BGP peers for a VPC.", + "isasync": true, + "name": "changeBgpPeersForVpc", + "params": [ { "description": "UUID of the VPC which the Bgp Peers are associated to.", "length": 255, @@ -15725,33 +15756,42 @@ "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": true, "type": "uuid" + }, + { + "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,changeBgpPeersForVpc", + "required": false, + "type": "list" } ], "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", "response": [ { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "the account of the bgp peer", + "name": "account", + "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "password of bgp peer", + "name": "password", "type": "string" }, + {}, { - "description": "the account of the bgp peer", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -15760,9 +15800,9 @@ "type": "integer" }, { - "description": "the domain name of the bgp peer", - "name": "domain", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { "description": "IPv4 address of bgp peer", @@ -15770,47 +15810,46 @@ "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "password of bgp peer", - "name": "password", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, - {}, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, + {}, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" - }, - {} + } ], "since": "4.20.0" }, @@ -15820,31 +15859,32 @@ "name": "addBaremetalPxePingServer", "params": [ { - "description": "the Physical Network ID", + "description": "Pod Id", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": true, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, "type": "uuid" }, { - "description": "Tftp root directory of PXE server", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "tftpdir", + "name": "username", "required": true, "type": "string" }, { - "description": "Username of PING storage server", + "description": "the Physical Network ID", "length": 255, - "name": "pingcifsusername", - "required": false, - "type": "string" + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "PING storage server ip", + "description": "URL of the external pxe device", "length": 255, - "name": "pingstorageserverip", + "name": "url", "required": true, "type": "string" }, @@ -15856,136 +15896,96 @@ "type": "string" }, { - "description": "Pod Id", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "name": "tftpdir", + "required": true, + "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "Username of PING storage server", "length": 255, - "name": "password", - "required": true, + "name": "pingcifsusername", + "required": false, "type": "string" }, { - "description": "URL of the external pxe device", + "description": "Password of PING storage server", "length": 255, - "name": "url", - "required": true, + "name": "pingcifspassword", + "required": false, "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "Root directory on PING storage server", "length": 255, - "name": "username", + "name": "pingdir", "required": true, "type": "string" }, { - "description": "Root directory on PING storage server", + "description": "PING storage server ip", "length": 255, - "name": "pingdir", + "name": "pingstorageserverip", "required": true, "type": "string" }, { - "description": "Password of PING storage server", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "pingcifspassword", - "required": false, + "name": "password", + "required": true, "type": "string" } ], "related": "", "response": [ { - "description": "Root directory on PING storage server", - "name": "pingdir", - "type": "string" - }, - { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, + {}, { - "description": "url", - "name": "url", + "description": "device id of ", + "name": "id", "type": "string" }, - {}, { "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", - "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": "device id of ", - "name": "id", + "description": "url", + "name": "url", "type": "string" }, { "description": "PING storage server ip", "name": "pingstorageserverip", "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": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "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", + "description": "Root directory on PING storage server", + "name": "pingdir", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tftp root directory of PXE server", + "name": "tftpdir", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", + "type": "string" } ] }, @@ -15995,11 +15995,11 @@ "name": "listPortableIpRanges", "params": [ { - "description": "List by keyword", + "description": "Id of a Region", "length": 255, - "name": "keyword", + "name": "regionid", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -16009,129 +16009,129 @@ "type": "integer" }, { - "description": "Id of the portable ip range", + "description": "", "length": 255, - "name": "id", - "related": "createPortableIpRange,listPortableIpRanges", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Id of a Region", + "description": "List by keyword", "length": 255, - "name": "regionid", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "Id of the portable ip range", "length": 255, - "name": "page", + "name": "id", + "related": "createPortableIpRange,listPortableIpRanges", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createPortableIpRange", "response": [ + {}, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the end ip of the portable IP range", + "name": "endip", "type": "string" }, + {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "portable IP range ID", + "name": "id", "type": "string" }, - { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the start ip of the portable IP range", - "name": "startip", - "type": "string" - }, - { - "description": "portable IP range ID", - "name": "id", - "type": "string" - }, - { - "description": "the end ip of the portable IP range", - "name": "endip", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", "response": [ + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, { "description": "Region Id in which global load balancer is created", "name": "regionid", "type": "integer" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "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": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", + "description": "the account ID the portable IP address is associated with", + "name": "accountid", "type": "string" } ], "type": "list" }, - {}, - {}, + { + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" + }, + { + "description": "the start ip of the portable IP range", + "name": "startip", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the gateway of the VLAN IP range", "name": "gateway", @@ -16148,35 +16148,35 @@ "description": "The ID of the virtual machine", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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 ID of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - {}, { "description": "Base64 encoded VM user data", "name": "userdata", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "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", "name": "jobstatus", "type": "integer" - }, - {} + } ], "since": "4.4" }, @@ -16185,6 +16185,14 @@ "isasync": false, "name": "createNetworkPermissions", "params": [ + { + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "list" + }, { "description": "the network ID", "length": 255, @@ -16193,14 +16201,6 @@ "required": true, "type": "uuid" }, - { - "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": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "list" - }, { "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, @@ -16209,10 +16209,10 @@ "type": "list" }, { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "accountids", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "list" } @@ -16223,23 +16223,23 @@ "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": "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" }, @@ -16258,8 +16258,11 @@ } ], "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", @@ -16270,16 +16273,13 @@ "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" - } + {} ] }, { @@ -16306,9 +16306,9 @@ "related": "", "response": [ { - "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" }, { "description": "the UUID of the latest async job acting on this object", @@ -16320,7 +16320,11 @@ "name": "ipaddress", "type": "string" }, - {}, + { + "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", @@ -16331,17 +16335,13 @@ "name": "nicid", "type": "string" }, + {}, + {}, { - "description": "the ID of the vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the secondary private IP addr", - "name": "id", - "type": "string" + "description": "the list of Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, - {}, { "description": "the ID of the network", "name": "networkid", @@ -16355,12 +16355,21 @@ "name": "quotaTariffUpdate", "params": [ { - "description": "DEPRECATED. Integer value for the usage type of the resource", + "description": "Position in the execution sequence for tariffs of the same type", "length": 255, - "name": "usagetype", + "name": "position", "required": false, + "since": "4.20.0.0", "type": "integer" }, + { + "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule.", + "length": 65535, + "name": "activationrule", + "required": false, + "since": "4.18.0.0", + "type": "string" + }, { "description": "Quota tariff's name", "length": 65535, @@ -16377,14 +16386,6 @@ "since": "4.18.0.0", "type": "date" }, - { - "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule.", - "length": 65535, - "name": "activationrule", - "required": false, - "since": "4.18.0.0", - "type": "string" - }, { "description": "The quota tariff value of the resource as per the default unit.", "length": 255, @@ -16401,73 +16402,52 @@ "type": "string" }, { - "description": "DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "description": "DEPRECATED. Integer value for the usage type of the resource", "length": 255, - "name": "startdate", + "name": "usagetype", "required": false, - "type": "date" + "type": "integer" }, { - "description": "Position in the execution sequence for tariffs of the same type", + "description": "DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", "length": 255, - "name": "position", + "name": "startdate", "required": false, - "since": "4.20.0.0", - "type": "integer" + "type": "date" } ], "related": "quotaTariffList,quotaTariffCreate", "response": [ {}, - { - "description": "when the quota tariff was removed", - "name": "removed", - "type": "date" - }, - { - "description": "position in the execution sequence for tariffs of the same type", - "name": "position", - "type": "integer" - }, - { - "description": "usageDiscriminator", - "name": "usageDiscriminator", - "type": "string" - }, - { - "description": "the start date of the quota tariff", - "name": "effectiveDate", - "type": "date" - }, { "description": "activation rule of the quota tariff", "name": "activationRule", "type": "string" }, { - "description": "tariffValue", - "name": "tariffValue", - "type": "bigdecimal" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "currency", - "name": "currency", + "description": "name", + "name": "name", "type": "string" }, { - "description": "usageType", - "name": "usageType", - "type": "int" + "description": "usageUnit", + "name": "usageUnit", + "type": "string" }, { - "description": "usageName", - "name": "usageName", + "description": "the ID of the tariff", + "name": "id", "type": "string" }, { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" + "description": "description", + "name": "description", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -16475,36 +16455,56 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "usageDiscriminator", + "name": "usageDiscriminator", "type": "string" }, { - "description": "the ID of the tariff", - "name": "id", + "description": "currency", + "name": "currency", "type": "string" }, { - "description": "usageUnit", - "name": "usageUnit", - "type": "string" + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" }, { - "description": "description", - "name": "description", - "type": "string" + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" }, + {}, { "description": "usage type description", "name": "usageTypeDescription", "type": "string" }, { - "description": "name", - "name": "name", + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" + }, + { + "description": "usageType", + "name": "usageType", + "type": "int" + }, + { + "description": "usageName", + "name": "usageName", "type": "string" }, - {} + { + "description": "position in the execution sequence for tariffs of the same type", + "name": "position", + "type": "integer" + } ], "since": "4.7.0" }, @@ -16528,6 +16528,13 @@ "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", @@ -16537,14 +16544,7 @@ "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" - }, - {}, - {} + } ] }, { @@ -16552,21 +16552,21 @@ "isasync": false, "name": "deleteHost", "params": [ - { - "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": "forced", - "required": false, - "type": "boolean" - }, { "description": "the host ID", "length": 255, "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" }, + { + "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": "forced", + "required": false, + "type": "boolean" + }, { "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", "length": 255, @@ -16576,27 +16576,27 @@ } ], "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": "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" } ] }, @@ -16606,30 +16606,32 @@ "name": "deleteResourceIcon", "params": [ { - "description": "list of resources to upload the icon/image for", + "description": "type of the resource", "length": 255, - "name": "resourceids", + "name": "resourcetype", "required": true, - "type": "list" + "type": "string" }, { - "description": "type of the resource", + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "resourcetype", + "name": "resourceids", "required": true, - "type": "string" + "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 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", @@ -16637,12 +16639,10 @@ "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.16.0.0" }, @@ -16654,33 +16654,23 @@ "related": "", "response": [ { - "description": "the retention time for Instances disks stats", - "name": "instancesdisksstatsretentiontime", - "type": "integer" - }, - { - "description": "true if regular user is allowed to create projects", - "name": "allowusercreateprojects", + "description": "true if stats are collected only for user instances, false if system instance stats are also collected", + "name": "instancesstatsuseronly", "type": "boolean" }, - { - "description": "maximum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingmaxsize", - "type": "long" - }, { "description": "the min CPU count for the service offering used by the shared filesystem instance", "name": "sharedfsvmmincpucount", "type": "integer" }, { - "description": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", - "type": "boolean" + "description": "time interval (in seconds) to reset api count", + "name": "apilimitinterval", + "type": "integer" }, { - "description": "true if users are allowed to force stop a vm, false otherwise", - "name": "allowuserforcestopvm", + "description": "true if user and domain admins can set templates to be shared, false otherwise", + "name": "userpublictemplateenabled", "type": "boolean" }, { @@ -16689,122 +16679,132 @@ "type": "string" }, { - "description": "true if stats are retained for instance disks otherwise false", - "name": "instancesdisksstatsretentionenabled", + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", "type": "boolean" }, { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the min Ram size for the service offering used by the shared filesystem instance", + "name": "sharedfsvmminramsize", "type": "integer" }, { - "description": "version of the cloud stack", - "name": "cloudstackversion", - "type": "string" + "description": "true if users are allowed to force stop a vm, false otherwise", + "name": "allowuserforcestopvm", + "type": "boolean" }, { - "description": "default page size in the UI for various views, value set in the configurations", - "name": "defaultuipagesize", - "type": "long" + "description": "Max allowed number of api requests within the specified interval", + "name": "apilimitmax", + "type": "integer" }, { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", + "description": "true if stats are retained for instance disks otherwise false", + "name": "instancesdisksstatsretentionenabled", "type": "boolean" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "true if region wide secondary is enabled, false otherwise", + "name": "regionsecondaryenabled", "type": "boolean" }, { - "description": "the retention time for Instances stats", + "description": "true if the user can recover and expunge volumes, false otherwise", + "name": "allowuserexpungerecovervolume", + "type": "boolean" + }, + { + "description": "the retention time for Instances stats", "name": "instancesstatsretentiontime", "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if Kubernetes Service plugin is enabled, false otherwise", - "name": "kubernetesserviceenabled", + "description": "true if regular user is allowed to create projects", + "name": "allowusercreateprojects", "type": "boolean" }, { - "description": "true if region supports elastic load balancer on basic zones", - "name": "supportELB", - "type": "string" - }, - { - "description": "Display name for custom hypervisor", - "name": "customhypervisordisplayname", - "type": "string" + "description": "maximum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingmaxsize", + "type": "long" }, { - "description": "time interval (in seconds) to reset api count", - "name": "apilimitinterval", - "type": "integer" + "description": "default page size in the UI for various views, value set in the configurations", + "name": "defaultuipagesize", + "type": "long" }, - {}, { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", + "description": "true if the user can recover and expunge virtualmachines, false otherwise", + "name": "allowuserexpungerecovervm", "type": "boolean" }, { - "description": "Max allowed number of api requests within the specified interval", - "name": "apilimitmax", - "type": "integer" + "description": "version of the cloud stack", + "name": "cloudstackversion", + "type": "string" }, { - "description": "true if the user can recover and expunge virtualmachines, false otherwise", - "name": "allowuserexpungerecovervm", + "description": "true if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", "type": "boolean" }, { - "description": "true if the user can recover and expunge volumes, false otherwise", - "name": "allowuserexpungerecovervolume", + "description": "true if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", "type": "boolean" }, { - "description": "true if region wide secondary is enabled, false otherwise", - "name": "regionsecondaryenabled", - "type": "boolean" + "description": "true if region supports elastic load balancer on basic zones", + "name": "supportELB", + "type": "string" }, { - "description": "true if users can see all accounts within the same domain, false otherwise", - "name": "allowuserviewalldomainaccounts", + "description": "minimum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingminsize", + "type": "long" + }, + { + "description": "true if snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", "type": "boolean" }, { - "description": "the min Ram size for the service offering used by the shared filesystem instance", - "name": "sharedfsvmminramsize", + "description": "the retention time for Instances disks stats", + "name": "instancesdisksstatsretentiontime", "type": "integer" }, { - "description": "minimum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingminsize", - "type": "long" + "description": "Display name for custom hypervisor", + "name": "customhypervisordisplayname", + "type": "string" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, + {}, { "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", "name": "kubernetesclusterexperimentalfeaturesenabled", "type": "boolean" }, { - "description": "true if user and domain admins can set templates to be shared, false otherwise", - "name": "userpublictemplateenabled", + "description": "true if users can see all accounts within the same domain, false otherwise", + "name": "allowuserviewalldomainaccounts", "type": "boolean" - }, - {} + } ] }, { @@ -16822,15 +16822,11 @@ } ], "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" }, {}, { @@ -16838,11 +16834,15 @@ "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" } ] }, @@ -16852,11 +16852,12 @@ "name": "updateNetworkServiceProvider", "params": [ { - "description": "Enabled/Disabled/Shutdown the physical network service provider", + "description": "network service provider id", "length": 255, - "name": "state", - "required": false, - "type": "string" + "name": "id", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "required": true, + "type": "uuid" }, { "description": "the list of services to be enabled for this physical network service provider", @@ -16866,12 +16867,11 @@ "type": "list" }, { - "description": "network service provider id", + "description": "Enabled/Disabled/Shutdown the physical network service provider", "length": 255, - "name": "id", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", - "required": true, - "type": "uuid" + "name": "state", + "required": false, + "type": "string" } ], "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", @@ -16881,11 +16881,6 @@ "name": "physicalnetworkid", "type": "string" }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", @@ -16897,31 +16892,36 @@ "type": "list" }, { - "description": "the provider name", - "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": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" } ], "since": "3.0.0" @@ -16931,53 +16931,58 @@ "isasync": true, "name": "checkVolume", "params": [ - { - "description": "parameter to repair the volume, leaks or all are the possible values", - "length": 255, - "name": "repair", - "required": false, - "type": "string" - }, { "description": "The ID of the volume", "length": 255, "name": "id", - "related": "importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "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": "parameter to repair the volume, leaks or all are the possible values", + "length": 255, + "name": "repair", + "required": false, + "type": "string" } ], - "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "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": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, + {}, { - "description": "pod id of the volume", - "name": "podid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, - {}, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { @@ -16986,170 +16991,135 @@ "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "name of the availability zone", - "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": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "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", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "ID of the disk volume", - "name": "id", + "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": "name of the virtual machine", - "name": "vmname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "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 display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "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 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 chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { "description": "the display text of the disk offering", @@ -17157,82 +17127,67 @@ "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { "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", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -17241,33 +17196,33 @@ "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": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -17279,69 +17234,74 @@ "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 path of the volume", - "name": "path", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "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": "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", + "description": "the date the disk volume was created", + "name": "created", "type": "date" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { "description": "the read (IO) of disk on the vm", @@ -17349,29 +17309,69 @@ "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "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", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "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": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" } ], "since": "4.19.1" @@ -17382,27 +17382,26 @@ "name": "listManagementServersMetrics", "params": [ { - "description": "include system level stats", + "description": "List by keyword", "length": 255, - "name": "system", - "related": "listManagementServersMetrics", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the name of the management server", + "description": "include system level stats", "length": 255, - "name": "name", + "name": "system", + "related": "listManagementServersMetrics", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the id of the management server", + "description": "", "length": 255, - "name": "id", - "related": "listManagementServers", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -17412,148 +17411,133 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the name of the management server", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "the id of the management server", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listManagementServers", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", - "type": "string" - }, - { - "description": "the amount of memory used by this Management Server", - "name": "heapmemoryused", - "type": "long" - }, - { - "description": "the load averages for 1 5 and 15 minutes", - "name": "systemloadaverages", - "type": "double[]" - }, - { - "description": "the number of agents this Management Server is responsible for", - "name": "agentcount", + "description": "The number of runnable threads", + "name": "threadsrunnablecount", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Total system memory", + "name": "systemmemorytotal", "type": "string" }, { - "description": "Virtual size of the fully loaded process", - "name": "systemmemoryvirtualsize", + "description": "the version of the management server", + "name": "version", "type": "string" }, { - "description": "the amount of memory allocated to this Management Server", - "name": "heapmemorytotal", - "type": "long" + "description": "the java distribution name running the management server process", + "name": "javadistribution", + "type": "string" }, { - "description": "the system is running against a local database", - "name": "dbislocal", + "description": "the system has a usage server running locally", + "name": "usageislocal", "type": "boolean" }, + {}, + { + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" + }, { "description": "the IP Address for this Management Server", "name": "serviceip", "type": "string" }, { - "description": "The number of threads", - "name": "threadstotalcount", + "description": "The number of terminated threads", + "name": "threadsteminatedcount", "type": "integer" }, + { + "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" }, { - "description": "the ID of the management server", - "name": "id", + "description": "the version of the java distribution running the management server process", + "name": "javaversion", "type": "string" }, { - "description": "the system load for user, and system processes and the system idle cycles", - "name": "systemcycleusage", - "type": "long[]" - }, - { - "description": "Total system memory", - "name": "systemmemorytotal", - "type": "string" + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" }, { - "description": "the system has a usage server running locally", - "name": "usageislocal", - "type": "boolean" + "description": "the number of processors available to the JVM", + "name": "availableprocessors", + "type": "integer" }, - {}, { - "description": "the name of the management server", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The number of daemon threads", - "name": "threadsdaemoncount", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "The number of threads", + "name": "threadstotalcount", + "type": "integer" }, { - "description": "Free system memory", - "name": "systemmemoryfree", - "type": "string" + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" }, { - "description": "The number of terminated threads", - "name": "threadsteminatedcount", - "type": "integer" + "description": "the state of the management server", + "name": "state", + "type": "state" }, { - "description": "the version of the management server", - "name": "version", + "description": "Virtual size of the fully loaded process", + "name": "systemmemoryvirtualsize", "type": "string" }, { - "description": "The number of blocked threads", - "name": "threadsblockedcount", - "type": "integer" - }, - { - "description": "The number of waiting threads", - "name": "threadswaitingcount", - "type": "integer" + "description": "the system load for user, and system processes and the system idle cycles", + "name": "systemcycleusage", + "type": "long[]" }, { - "description": "the number of processors available to the JVM", - "name": "availableprocessors", - "type": "integer" + "description": "the ID of the management server", + "name": "id", + "type": "string" }, { - "description": "the current cpu load", - "name": "cpuload", - "type": "string" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { "description": "Amount of memory used", @@ -17561,59 +17545,75 @@ "type": "string" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", "type": "string" }, { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the system is running against a local database", + "name": "dbislocal", + "type": "boolean" }, { - "description": "the number of client sessions active on this Management Server", - "name": "sessions", + "description": "the amount of memory allocated to this Management Server", + "name": "heapmemorytotal", "type": "long" }, + {}, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "the load averages for 1 5 and 15 minutes", + "name": "systemloadaverages", + "type": "double[]" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "The number of daemon threads", + "name": "threadsdaemoncount", + "type": "integer" + }, + { + "description": "Free system memory", + "name": "systemmemoryfree", "type": "string" }, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" + "description": "the current cpu load", + "name": "cpuload", + "type": "string" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "the number of agents this Management Server is responsible for", + "name": "agentcount", + "type": "integer" }, { - "description": "The number of runnable threads", - "name": "threadsrunnablecount", + "description": "The number of blocked threads", + "name": "threadsblockedcount", "type": "integer" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "the name of the management server", + "name": "name", "type": "string" }, { - "description": "the total system cpu capacity", - "name": "systemtotalcpucycles", - "type": "double" + "description": "the number of client sessions active on this Management Server", + "name": "sessions", + "type": "long" + }, + { + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", + "type": "long" + }, + { + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" } ], "since": "4.17.0" @@ -17631,21 +17631,21 @@ "since": "4.4", "type": "map" }, - { - "description": "The ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - }, { "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": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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" + }, + { + "description": "The ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" } ], "response": [ @@ -17654,23 +17654,23 @@ "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 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" - } + }, + {}, + {} ] }, { @@ -17679,26 +17679,18 @@ "name": "listInstanceGroups", "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": "list instance groups by name", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -17715,12 +17707,11 @@ "type": "integer" }, { - "description": "list instance groups by 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": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list only resources belonging to the domain specified", @@ -17731,19 +17722,28 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list instance groups by name", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, + { + "description": "list instance groups by ID", + "length": 255, + "name": "id", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -17755,18 +17755,19 @@ "related": "createInstanceGroup,updateInstanceGroup", "response": [ { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, + {}, { - "description": "the name of the instance group", - "name": "name", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, { @@ -17775,25 +17776,19 @@ "type": "boolean" }, { - "description": "the ID of the instance group", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the project name of the instance group", - "name": "project", + "description": "the account owning the instance group", + "name": "account", "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": "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": "time and date the instance group was created", @@ -17801,18 +17796,23 @@ "type": "date" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "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": "the project name of the instance group", + "name": "project", + "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the ID of the instance group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, {} @@ -17841,64 +17841,54 @@ ], "related": "listStaticRoutes", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "VPC the static route belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "static route CIDR", - "name": "cidr", - "type": "string" - }, { "description": "the project name of the static route", "name": "project", "type": "string" }, { - "description": "the ID of static route", - "name": "id", + "description": "the domain associated with the static route", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the static route", - "name": "domain", + "description": "the project id of the static route", + "name": "projectid", "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 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": "customer associated with the tag", - "name": "customer", + "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": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -17912,36 +17902,36 @@ "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": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the domain path associated with the static route", - "name": "domainpath", + "description": "the state of the static route", + "name": "state", "type": "string" }, { @@ -17949,20 +17939,30 @@ "name": "gatewayid", "type": "string" }, + {}, + { + "description": "static route CIDR", + "name": "cidr", + "type": "string" + }, { "description": "the account associated with the static route", "name": "account", "type": "string" }, { - "description": "the project id of the static route", - "name": "projectid", + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, - {}, { - "description": "the state of the static route", - "name": "state", + "description": "the ID of static route", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -17987,14 +17987,20 @@ } ], "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": "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" }, { @@ -18002,12 +18008,6 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {} ] }, @@ -18023,13 +18023,6 @@ "required": false, "type": "string" }, - { - "description": "updates domain with this name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "ID of domain to update", "length": 255, @@ -18037,90 +18030,81 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": true, "type": "uuid" + }, + { + "description": "updates domain with this name", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "response": [ { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "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 domain", - "name": "vmlimit", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, - { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" - }, { "description": "the total memory (in MB) owned by domain", "name": "memorytotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" - }, - {}, - { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "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 level of the domain", - "name": "level", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { "description": "the total number of networks owned by domain", @@ -18128,64 +18112,64 @@ "type": "long" }, { - "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 number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "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": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { "description": "the state of the domain", @@ -18193,60 +18177,76 @@ "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, + {}, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "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 volume available for this domain", - "name": "volumeavailable", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, {}, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "the total number of vpcs available to be created for this domain", "name": "vpcavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { "description": "the network domain", @@ -18254,43 +18254,33 @@ "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the name of the domain", - "name": "name", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { @@ -18299,8 +18289,18 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" } ] @@ -18322,34 +18322,39 @@ "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "is group for display to the regular user", - "name": "fordisplay", + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "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 project id of the vm group", + "name": "projectid", + "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "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 vm group", - "name": "domain", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "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 load balancer rule ID", @@ -18357,64 +18362,64 @@ "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", + "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 number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "the public port", + "name": "publicport", + "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "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 public ip address id", - "name": "publicipid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the public ip address", + "name": "publicip", + "type": "string" }, {}, { @@ -18423,49 +18428,44 @@ "type": "int" }, { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, + {}, { - "description": "the domain ID of the vm group", - "name": "domainid", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" } ] @@ -18476,19 +18476,18 @@ "name": "createSnapshotPolicy", "params": [ { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "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": "intervaltype", + "name": "schedule", "required": true, "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.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" + "name": "timezone", + "required": true, + "type": "string" }, { "description": "an optional field, whether to the display the policy to the end user or not", @@ -18498,6 +18497,13 @@ "since": "4.4", "type": "boolean" }, + { + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, { "description": "maximum number of snapshots to retain", "length": 255, @@ -18506,41 +18512,35 @@ "type": "integer" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "length": 255, - "name": "timezone", + "name": "intervaltype", "required": true, "type": "string" }, { - "description": "Map of tags (key/value pairs)", + "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": "tags", + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "map" + "type": "list" }, { "description": "the ID of the disk volume", "length": 255, "name": "volumeid", - "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "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": "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" } ], "related": "updateSnapshotPolicy,listSnapshotPolicies", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" }, { "description": "the ID of the disk volume", @@ -18548,113 +18548,113 @@ "type": "string" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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 value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "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", + "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": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "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", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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" } ], "type": "set" }, - {}, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, - { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, - { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" - }, + {}, {} ] }, @@ -18673,27 +18673,27 @@ } ], "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": "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", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.11" @@ -18707,29 +18707,29 @@ "description": "The ID of the volume to unmanage", "length": 255, "name": "id", - "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "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" } ], "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", @@ -18739,97 +18739,29 @@ "since": "4.19.1" }, { - "description": "Adds an API permission to a role", + "description": "List system virtual machines.", "isasync": false, - "name": "createRolePermission", + "name": "listSystemVms", "params": [ { - "description": "The rule permission, allow or deny. Default: deny.", - "length": 255, - "name": "permission", - "required": true, - "type": "string" - }, - { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, - "type": "uuid" - }, - { - "description": "The API name or wildcard rule such as list*", + "description": "", "length": 255, - "name": "rule", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "The description of the role permission", + "description": "", "length": 255, - "name": "description", + "name": "pagesize", "required": false, - "type": "string" - } - ], - "related": "listRolePermissions", - "response": [ - { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", - "type": "string" - }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", "type": "integer" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" - }, - { - "description": "the ID of the role permission", - "name": "id", - "type": "string" - }, - { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" - }, - { - "description": "the description of the role permission", - "name": "description", - "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "List system virtual machines.", - "isasync": false, - "name": "listSystemVms", - "params": [ - { - "description": "the host ID of the system VM", + "description": "the Pod ID of the system VM", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, @@ -18841,13 +18773,11 @@ "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "the name of the system VM", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "name", "required": false, - "since": "3.0.1", - "type": "uuid" + "type": "string" }, { "description": "List by keyword", @@ -18857,20 +18787,14 @@ "type": "string" }, { - "description": "the ID of the system VM", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, + "since": "3.0.1", "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, @@ -18879,10 +18803,10 @@ "type": "string" }, { - "description": "the Pod ID of the system VM", + "description": "the host ID of the system VM", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, @@ -18895,65 +18819,80 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the name of the system VM", + "description": "the ID of the system VM", "length": 255, - "name": "name", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, - "type": "string" + "type": "uuid" } ], "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" + }, + { + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, + {}, { "description": "the hypervisor on which the template runs", "name": "hypervisor", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { @@ -18962,48 +18901,43 @@ "type": "string" }, { - "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 gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "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 private IP address for the system VM", - "name": "privateip", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { @@ -19012,39 +18946,33 @@ "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "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 link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "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 systemvm agent version", - "name": "version", + "description": "the agent state of the system VM", + "name": "agentstate", "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": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { @@ -19053,77 +18981,149 @@ "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the hostname for the system VM", "name": "hostname", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "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 Pod name for the system VM", + "name": "podname", + "type": "string" + }, + { + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, {}, { - "description": "the gateway for the system VM", - "name": "gateway", + "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 netmask for the system VM", - "name": "privatenetmask", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" + } + ] + }, + { + "description": "Adds an API permission to a role", + "isasync": false, + "name": "createRolePermission", + "params": [ + { + "description": "The rule permission, allow or deny. Default: deny.", + "length": 255, + "name": "permission", + "required": true, "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "The description of the role permission", + "length": 255, + "name": "description", + "required": false, "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": "ID of the role", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": true, + "type": "uuid" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "The API name or wildcard rule such as list*", + "length": 255, + "name": "rule", + "required": true, + "type": "string" + } + ], + "related": "listRolePermissions", + "response": [ + { + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", "type": "string" }, { - "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", + "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the role permission", + "name": "id", + "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", + "type": "string" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.9.0" }, { "description": "Detaches a disk volume from a virtual machine.", @@ -19134,7 +19134,7 @@ "description": "the ID of the disk volume", "length": 255, "name": "id", - "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "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" }, @@ -19149,27 +19149,27 @@ "description": "the ID of the virtual machine where the volume is detached from", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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" } ], - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "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 write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { "description": "id of the virtual machine", @@ -19177,94 +19177,156 @@ "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "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": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, { "description": "the disk utilization", "name": "utilization", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "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 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": "ID of the disk offering", - "name": "diskofferingid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "the list of resource tags associated", + "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": "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": "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 account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { "description": "name of the primary storage hosting the disk volume", @@ -19272,65 +19334,44 @@ "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "the path of the volume", - "name": "path", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - {}, - { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { "description": "the boolean state of whether the volume is destroyed or not", @@ -19338,43 +19379,38 @@ "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "ID of the disk volume", - "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": "pod id of the volume", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -19383,63 +19419,63 @@ "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "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 id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { @@ -19448,29 +19484,29 @@ "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "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 read (IO) of disk on the vm", @@ -19478,82 +19514,24 @@ "type": "long" }, { - "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 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": "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": "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": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, - {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { "description": "the chain info of the volume", @@ -19561,25 +19539,47 @@ "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": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + {}, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" - } + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + {} ] }, { @@ -19614,26 +19614,26 @@ ], "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" - }, {} ] }, @@ -19643,12 +19643,19 @@ "name": "listTungstenFabricAddressGroup", "params": [ { - "description": "the uuid of Tungsten-Fabric address group", + "description": "List by keyword", "length": 255, - "name": "addressgroupuuid", + "name": "keyword", "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "the ID of zone", "length": 255, @@ -19658,9 +19665,9 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric address group", "length": 255, - "name": "keyword", + "name": "addressgroupuuid", "required": false, "type": "string" }, @@ -19670,58 +19677,51 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "createTungstenFabricAddressGroup", "response": [ { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", + "description": "Tungsten-Fabric address group name", + "name": "name", "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", + "type": "string" }, + {}, + {}, { "description": "Tungsten-Fabric address group uuid", "name": "uuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", "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", + "type": "integer" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" }, - {}, { - "description": "Tungsten-Fabric address group name", - "name": "name", + "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": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -19741,31 +19741,36 @@ ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + {}, {}, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, { "description": "the out-of-band management action (if issued)", "name": "action", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - {}, { "description": "the out-of-band management interface address", "name": "address", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the operation result description", + "name": "description", "type": "string" }, { @@ -19774,9 +19779,9 @@ "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the out-of-band management driver for the host", @@ -19784,8 +19789,8 @@ "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { @@ -19794,14 +19799,9 @@ "type": "powerstate" }, { - "description": "the operation result description", - "name": "description", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -19816,6 +19816,14 @@ "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": "userfilter", + "required": false, + "since": "4.13", + "type": "string" + }, { "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, @@ -19832,26 +19840,18 @@ "type": "uuid" }, { - "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", + "description": "List by keyword", "length": 255, - "name": "userfilter", + "name": "keyword", "required": false, - "since": "4.13", "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -19864,14 +19864,8 @@ "related": "searchLdap,importLdapUsers", "response": [ { - "description": "The user's lastname", - "name": "lastname", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The user's domain", + "name": "domain", "type": "string" }, { @@ -19879,27 +19873,28 @@ "name": "conflictingusersource", "type": "string" }, - {}, { "description": "The user's email", "name": "email", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "The user's principle", "name": "principal", "type": "string" }, + {}, { - "description": "The user's domain", - "name": "domain", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "The user's firstname", "name": "firstname", @@ -19909,6 +19904,11 @@ "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" } ], "since": "4.2.0" @@ -19919,25 +19919,19 @@ "name": "createVMSchedule", "params": [ { - "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": "Description of the schedule", + "description": "Action to take on the VM (start/stop/reboot/force_stop/force_reboot).", "length": 255, - "name": "description", - "required": false, + "name": "action", + "required": true, "type": "string" }, { - "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": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "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,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 a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", @@ -19946,6 +19940,13 @@ "required": true, "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'", + "length": 255, + "name": "schedule", + "required": true, + "type": "string" + }, { "description": "Enable VM schedule. Defaults to true", "length": 255, @@ -19954,41 +19955,51 @@ "type": "boolean" }, { - "description": "Action to take on the VM (start/stop/reboot/force_stop/force_reboot).", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "action", - "required": true, - "type": "string" + "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'", + "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": "schedule", - "required": true, - "type": "string" + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "ID of the VM for which schedule is to be defined", + "description": "Description of the schedule", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" } ], "related": "updateVMSchedule", "response": [ - {}, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + }, + { + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, + { + "description": "Action", + "name": "action", + "type": "action" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Timezone of the schedule", - "name": "timezone", - "type": "string" - }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -19999,32 +20010,11 @@ "name": "id", "type": "string" }, - {}, - { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" - }, - { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" - }, { "description": "Description of VM schedule", "name": "description", "type": "string" }, - { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" - }, - { - "description": "ID of virtual machine", - "name": "virtualmachineid", - "type": "string" - }, { "description": "Cron formatted VM schedule", "name": "schedule", @@ -20036,9 +20026,19 @@ "type": "boolean" }, { - "description": "Action", - "name": "action", - "type": "action" + "description": "Timezone of the schedule", + "name": "timezone", + "type": "string" + }, + { + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" + }, + { + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" } ], "since": "4.19.0" @@ -20049,18 +20049,19 @@ "name": "listIpForwardingRules", "params": [ { - "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" + "type": "boolean" }, { - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -20073,220 +20074,219 @@ "description": "Lists all rules applied to the specified VM.", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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": "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": "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 only resources belonging to the domain specified", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Lists rule with the specified ID.", + "description": "", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list the rule belonging to this public IP address", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list the rule belonging to this public IP address", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" } ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "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 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 VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, { "description": "the VM display name for the port forwarding rule", "name": "virtualmachinedisplayname", "type": "string" }, - {}, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "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": "the project name where tag belongs to", + "name": "project", "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "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 VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "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 ending port of port forwarding rule's private port range", "name": "privateendport", "type": "string" }, + { + "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" + }, { "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 ID for the port forwarding rule", + "name": "virtualmachineid", + "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 state of the rule", + "name": "state", + "type": "string" + }, + { + "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + } ] }, { @@ -20295,9 +20295,9 @@ "name": "createSnapshot", "params": [ { - "description": "the name of the snapshot", + "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, @@ -20308,6 +20308,13 @@ "required": false, "type": "boolean" }, + { + "description": "the name of the snapshot", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", "length": 255, @@ -20316,80 +20323,83 @@ "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.", + "description": "quiesce vm if true", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "quiescevm", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Map of tags (key/value pairs)", + "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": "tags", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", "length": 255, - "name": "account", + "name": "policyid", + "related": "updateSnapshotPolicy,listSnapshotPolicies", "required": false, - "type": "string" + "type": "uuid" }, { "description": "The ID of the disk volume", "length": 255, "name": "volumeid", - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "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": "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.", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.19.0", - "type": "list" - }, - { - "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", - "length": 255, - "name": "policyid", - "related": "updateSnapshotPolicy,listSnapshotPolicies", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "quiesce vm if true", + "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": "quiescevm", + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "list" } ], "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", "response": [ { - "description": "the account associated with the snapshot", - "name": "account", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { @@ -20398,14 +20408,33 @@ "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "the status of the template", - "name": "status", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" + }, + { + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { @@ -20414,57 +20443,104 @@ "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", "type": "long" }, + {}, + { + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, + { + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, + {}, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, { "description": "ID of the datastore for the snapshot entry", "name": "datastoreid", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -20478,13 +20554,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -20498,67 +20569,26 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, - { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" - }, - { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" - }, - { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" - }, - { - "description": "state of the disk volume", - "name": "volumestate", - "type": "string" - }, { "description": "name of the snapshot", "name": "name", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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" }, { @@ -20566,40 +20596,10 @@ "name": "domain", "type": "string" }, - { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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": "ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" } ] }, @@ -20609,33 +20609,35 @@ "name": "listStoragePoolsMetrics", "params": [ { - "description": "the Pod ID for the storage pool", + "description": "the storage pool path", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "path", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the IP address for the storage pool", + "description": "the scope of the storage pool", "length": 255, - "name": "ipaddress", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, { - "description": "the storage pool path", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "path", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "keyword", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -20645,36 +20647,25 @@ "type": "integer" }, { - "description": "If true, lists the custom stats of the storage pool", - "length": 255, - "name": "storagecustomstats", - "required": false, - "since": "4.18.1", - "type": "boolean" - }, - { - "description": "list storage pools belongig to the specific cluster", + "description": "the name of the storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Zone ID for the storage pool", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "host ID of the storage pools", + "description": "", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the status of the storage pool", @@ -20684,12 +20675,12 @@ "type": "string" }, { - "description": "the scope of the storage pool", + "description": "list storage pools belongig to the specific cluster", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of the storage pool", @@ -20700,157 +20691,166 @@ "type": "uuid" }, { - "description": "", + "description": "If true, lists the custom stats of the storage pool", "length": 255, - "name": "page", + "name": "storagecustomstats", "required": false, - "type": "integer" + "since": "4.18.1", + "type": "boolean" }, { - "description": "the name of the storage pool", + "description": "the IP address for the storage pool", "length": 255, - "name": "name", + "name": "ipaddress", "required": false, "type": "string" + }, + { + "description": "host ID of the storage pools", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the storage pool type", - "name": "type", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", + "description": "disk size allocated in GiB", + "name": "disksizeallocatedgb", + "type": "string" + }, + { + "description": "storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", "type": "boolean" }, + {}, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, + { + "description": "storage usage disable threshold exceeded", + "name": "storageusagedisablethreshold", + "type": "boolean" + }, { "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, + {}, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the storage pool path", - "name": "path", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", + "type": "boolean" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "disk size used in GiB", + "name": "disksizeusedgb", "type": "string" }, { - "description": "disk size in GiB", - "name": "disksizetotalgb", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, - {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "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", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { @@ -20859,28 +20859,33 @@ "type": "string" }, { - "description": "disk size used in GiB", - "name": "disksizeusedgb", - "type": "string" + "description": "storage usage notification threshold exceeded", + "name": "storageusagethreshold", + "type": "boolean" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "disk size in GiB", + "name": "disksizetotalgb", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { @@ -20889,9 +20894,9 @@ "type": "long" }, { - "description": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", - "type": "boolean" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { "description": "the storage pool capabilities", @@ -20899,24 +20904,19 @@ "type": "map" }, { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", - "type": "boolean" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" } ], "since": "4.9.3" @@ -20926,6 +20926,13 @@ "isasync": false, "name": "createSSHKeyPair", "params": [ + { + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "Name of the keypair", "length": 255, @@ -20948,30 +20955,18 @@ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" - }, - { - "description": "an optional account for the ssh key. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the owner of the keypair", + "name": "account", "type": "string" }, { - "description": "Name of the keypair", - "name": "name", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { @@ -20979,48 +20974,53 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "the domain id of the keypair owner", "name": "domainid", "type": "string" }, { - "description": "Private key", - "name": "privatekey", + "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": "Name of the keypair", + "name": "name", "type": "string" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Private key", + "name": "privatekey", "type": "string" }, { - "description": "the owner of the keypair", - "name": "account", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, - {}, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, - {} + { + "description": "the project name of the keypair owner", + "name": "project", + "type": "string" + } ] }, { @@ -21029,18 +21029,19 @@ "name": "listTungstenFabricServiceGroup", "params": [ { - "description": "List by keyword", + "description": "the ID of zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "the uuid of Tungsten-Fabric service group", @@ -21050,12 +21051,11 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -21067,15 +21067,20 @@ ], "related": "createTungstenFabricServiceGroup", "response": [ + { + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric service group start port", - "name": "startport", - "type": "int" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, { "description": "Tungsten-Fabric service group name", @@ -21088,14 +21093,9 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" }, {}, { @@ -21103,16 +21103,16 @@ "name": "endport", "type": "int" }, + { + "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 service group uuid", - "name": "uuid", - "type": "string" } ] }, @@ -21129,11 +21129,11 @@ "type": "integer" }, { - "description": "user to security group mapping", + "description": "type of the icmp message being sent", "length": 255, - "name": "usersecuritygrouplist", + "name": "icmptype", "required": false, - "type": "map" + "type": "integer" }, { "description": "start port for this egress rule", @@ -21143,17 +21143,9 @@ "type": "integer" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", - "required": false, - "type": "uuid" - }, - { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "TCP is default. UDP is the other supported protocol", "length": 255, - "name": "securitygroupname", + "name": "protocol", "required": false, "type": "string" }, @@ -21165,6 +21157,21 @@ "required": false, "type": "uuid" }, + { + "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" + }, + { + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, { "description": "an optional account for the security group. Must be used with domainId.", "length": 255, @@ -21173,19 +21180,19 @@ "type": "string" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "user to security group mapping", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "usersecuritygrouplist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "type of the icmp message being sent", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "icmptype", + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "error code for this icmp message", @@ -21195,16 +21202,9 @@ "type": "integer" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "TCP is default. UDP is the other supported protocol", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "protocol", + "name": "securitygroupname", "required": false, "type": "string" } @@ -21217,19 +21217,25 @@ "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -21238,21 +21244,15 @@ "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 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", @@ -21263,13 +21263,8 @@ "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", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -21278,13 +21273,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -21293,13 +21283,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -21308,13 +21298,23 @@ "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 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" } ], @@ -21326,9 +21326,9 @@ "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" @@ -21339,26 +21339,26 @@ "name": "listStoragePools", "params": [ { - "description": "If true, lists the custom stats of the storage pool", + "description": "", "length": 255, - "name": "storagecustomstats", + "name": "page", "required": false, - "since": "4.18.1", - "type": "boolean" + "type": "integer" }, { - "description": "the status of the storage pool", + "description": "the ID of the storage pool", "length": 255, - "name": "status", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the status of the storage pool", "length": 255, - "name": "page", + "name": "status", "required": false, - "type": "integer" + "type": "string" }, { "description": "list storage pools belongig to the specific cluster", @@ -21369,42 +21369,33 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the Zone ID for the storage pool", + "description": "the name of the storage pool", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the storage pool", + "description": "", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "host ID of the storage pools", + "description": "the IP address for the storage pool", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "name": "ipaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the storage pool", + "description": "If true, lists the custom stats of the storage pool", "length": 255, - "name": "name", + "name": "storagecustomstats", "required": false, - "type": "string" + "since": "4.18.1", + "type": "boolean" }, { "description": "the scope of the storage pool", @@ -21415,24 +21406,26 @@ "type": "string" }, { - "description": "the storage pool path", + "description": "host ID of the storage pools", "length": 255, - "name": "path", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the IP address for the storage pool", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "ipaddress", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the Pod ID for the storage pool", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, @@ -21442,39 +21435,31 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "the storage pool path", + "length": 255, + "name": "path", + "required": false, + "type": "string" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" - }, - { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" - }, { "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 state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { "description": "the UUID of the latest async job acting on this object", @@ -21482,69 +21467,75 @@ "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, {}, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { @@ -21553,60 +21544,69 @@ "type": "map" }, { - "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 ID of the storage pool", - "name": "id", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "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", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, - {}, { "description": "the total disk size of the storage pool", "name": "disksizetotal", "type": "long" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" - }, - { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" } ] }, @@ -21616,9 +21616,17 @@ "name": "updateHypervisorCapabilities", "params": [ { - "description": "the maximum number of the hypervisor hosts per cluster ", + "description": "the hypervisor version for which the hypervisor capabilities are to be updated", "length": 255, - "name": "maxhostspercluster", + "name": "hypervisorversion", + "required": false, + "since": "4.19.1", + "type": "string" + }, + { + "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", + "length": 255, + "name": "maxdatavolumeslimit", "required": false, "since": "4.16.0", "type": "integer" @@ -21632,18 +21640,10 @@ "type": "string" }, { - "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", + "description": "set true to enable security group for this hypervisor.", "length": 255, - "name": "vmsnapshotenabled", + "name": "securitygroupenabled", "required": false, - "since": "4.16.0", "type": "boolean" }, { @@ -21655,95 +21655,95 @@ "type": "uuid" }, { - "description": "set true to enable storage motion support for this hypervisor", + "description": "the max number of Guest VMs per host for this hypervisor.", "length": 255, - "name": "storagemotionenabled", + "name": "maxguestslimit", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "long" }, { - "description": "set true to enable security group for this hypervisor.", + "description": "set true to enable VM snapshots for this hypervisor", "length": 255, - "name": "securitygroupenabled", + "name": "vmsnapshotenabled", "required": false, + "since": "4.16.0", "type": "boolean" }, { - "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", + "description": "the maximum number of the hypervisor hosts per cluster ", "length": 255, - "name": "maxdatavolumeslimit", + "name": "maxhostspercluster", "required": false, "since": "4.16.0", "type": "integer" }, { - "description": "the hypervisor version for which the hypervisor capabilities are to be updated", + "description": "set true to enable storage motion support for this hypervisor", "length": 255, - "name": "hypervisorversion", + "name": "storagemotionenabled", "required": false, - "since": "4.19.1", - "type": "string" + "since": "4.16.0", + "type": "boolean" } ], "related": "listHypervisorCapabilities", "response": [ + { + "description": "the hypervisor type", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "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", + "type": "integer" + }, + { + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" + }, { "description": "true if storage motion is supported", "name": "storagemotionenabled", "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", - "type": "long" - }, { "description": "true if VM snapshots are enabled for this hypervisor", "name": "vmsnapshotenabled", "type": "boolean" }, - {}, - {}, - { - "description": "the ID of the hypervisor capabilities row", - "name": "id", - "type": "string" - }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" }, { - "description": "the hypervisor type", - "name": "hypervisor", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, + {}, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the hypervisor capabilities row", + "name": "id", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "3.0.0" @@ -21754,23 +21754,23 @@ "name": "findHostsForMigration", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -21778,141 +21778,168 @@ "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": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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 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 used", "name": "memoryused", "type": "long" }, { - "description": "events available for the host", - "name": "events", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, + {}, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "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 OS category name of the host", - "name": "oscategoryname", + "description": "the host version", + "name": "version", "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": "the IP address of the host", - "name": "ipaddress", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "long" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the host hypervisor", + "name": "hypervisor", "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 memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", - "type": "boolean" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the cpu average load on the host", + "name": "averageload", "type": "long" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "events available for the host", + "name": "events", + "type": "string" + }, + {}, + { + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { @@ -21921,141 +21948,114 @@ "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, - {}, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "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", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "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", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "the name of the host", - "name": "name", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "long" - }, { "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": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "true if migrating a vm to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", "type": "boolean" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, - {}, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the OS category name of the host", + "name": "oscategoryname", "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 date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "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" } ] }, @@ -22076,76 +22076,76 @@ "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "response": [ { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", "name": "ipaddress", "type": "string" }, + {}, { - "description": "device name", - "name": "vsmdevicename", - "type": "string" - }, - { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", - "type": "string" - }, - { - "description": "The Device State (Enabled/Disabled) of the VSM", + "description": "device state", "name": "vsmdevicestate", "type": "string" }, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, - {}, { - "description": "device state", - "name": "vsmdevicestate", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, + { + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + }, { "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": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", + "type": "string" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", "type": "int" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "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 VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", + "type": "string" } ] }, @@ -22166,16 +22166,16 @@ "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 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": "is domain admin allowed to create offerings with tags", @@ -22190,11 +22190,11 @@ "name": "addNicToVirtualMachine", "params": [ { - "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", + "description": "IP Address for the new network", "length": 255, - "name": "dhcpoptions", + "name": "ipaddress", "required": false, - "type": "map" + "type": "string" }, { "description": "Mac Address for the new network", @@ -22203,6 +22203,13 @@ "required": false, "type": "string" }, + { + "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" + }, { "description": "Network ID", "length": 255, @@ -22215,534 +22222,288 @@ "description": "Virtual Machine ID", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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": "IP Address for the new network", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", - "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 domain in which the virtual machine exists", - "name": "domain", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "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" - }, - { - "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": "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 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 IPv6 address of network", - "name": "ip6address", - "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": "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": "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 ID of the nic", - "name": "id", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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 name of the corresponding network", - "name": "networkname", - "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" - } - ], - "type": "set" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the date when this virtual machine was created", "name": "created", "type": "date" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "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 name of the template for the virtual machine", - "name": "templatename", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "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": "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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 network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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 write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account owning the affinity group", + "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 project name of the affinity group", + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "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": "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 virtual machine exists", - "name": "domainid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "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 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 password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, { "description": "the target memory in VM (KiB)", "name": "memorytargetkbs", "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "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", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "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", + "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 date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, - {}, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -22751,240 +22512,304 @@ "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 project name where tag belongs to", - "name": "project", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 IPv6 address of network", + "name": "ip6address", + "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 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 ID of the corresponding network", + "name": "networkid", + "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 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": "Type of adapter if available", + "name": "adaptertype", + "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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "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" } ], "type": "set" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - {}, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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 ID of the virtual machine", + "name": "id", "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 backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the 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 internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "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 name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the 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 ", @@ -22992,47 +22817,57 @@ "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "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", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -23041,8 +22876,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -23051,150 +22886,53 @@ "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 name where tag belongs to", - "name": "project", + "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "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": "the type of the ICMP message response", - "name": "icmptype", + "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 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", + "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 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": "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 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" - } - ], - "type": "set" - }, { "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 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 type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -23203,8 +22941,8 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -23212,28 +22950,28 @@ "name": "tags", "response": [ { - "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": "id of the resource", + "name": "resourceid", "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -23242,13 +22980,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -23257,28 +22995,33 @@ "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": "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 id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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", @@ -23290,24 +23033,183 @@ "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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": "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": "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 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 project name of the group", + "name": "project", + "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 domain ID of the security group", + "name": "domainid", + "type": "string" } ], "type": "set" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + {}, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + {}, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { @@ -23316,9 +23218,107 @@ "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "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": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "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 name of the affinity group", + "name": "name", + "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 ID of the affinity group", + "name": "projectid", + "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 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" + } + ], + "type": "set" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" } ] }, @@ -23328,93 +23328,93 @@ "name": "listStaticRoutes", "params": [ { - "description": "list static route by id", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "listStaticRoutes", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list static routes by state", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "state", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list static route by id", "length": 255, - "name": "tags", + "name": "id", + "related": "listStaticRoutes", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list static routes by gateway id", + "description": "list static routes by vpc id", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "list static routes by vpc id", + "description": "List by keyword", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list static routes by state", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "state", "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": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "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": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list static routes by gateway id", "length": 255, - "name": "isrecursive", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -23426,80 +23426,38 @@ ], "related": "", "response": [ - { - "description": "the project id of the static route", - "name": "projectid", - "type": "string" - }, - { - "description": "static route CIDR", - "name": "cidr", - "type": "string" - }, - { - "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 static route", "name": "domainid", "type": "string" }, - {}, - { - "description": "the state of the static route", - "name": "state", - "type": "string" - }, - { - "description": "the domain path associated with the static route", - "name": "domainpath", - "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 static route", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the static route", - "name": "account", - "type": "string" - }, - {}, { "description": "the list of resource tags associated with static route", "name": "tags", "response": [ { - "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -23508,52 +23466,94 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the ID of static route", - "name": "id", + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "the project id of the static route", + "name": "projectid", "type": "string" }, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "the domain path associated with the static route", + "name": "domainpath", + "type": "string" + }, + { + "description": "the state of the static route", + "name": "state", "type": "string" }, + {}, { "description": "the domain associated with the static route", "name": "domain", "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 static route", + "name": "project", + "type": "string" + }, + {}, + { + "description": "static route CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the account associated with the static route", + "name": "account", + "type": "string" + }, + { + "description": "the ID of static route", + "name": "id", + "type": "string" + }, + { + "description": "VPC gateway the route is created for", + "name": "gatewayid", + "type": "string" } ] }, @@ -23563,19 +23563,35 @@ "name": "listPublicIpAddresses", "params": [ { - "description": "list only static NAT IP addresses", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isstaticnat", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "the virtual network for the IP address", + "length": 255, + "name": "forvirtualnetwork", "required": false, "type": "boolean" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "lists all public IP addresses by physical network ID", "length": 255, @@ -23585,18 +23601,20 @@ "type": "uuid" }, { - "description": "lists the specified IP address", + "description": "lists all public IP addresses associated to the network specified", "length": 255, - "name": "ipaddress", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only IPs used for load balancing", + "description": "lists all public IP addresses by VLAN ID", "length": 255, - "name": "forloadbalancing", + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -23606,6 +23624,14 @@ "required": false, "type": "uuid" }, + { + "description": "List IPs belonging to the VPC", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, { "description": "lists all public IP addresses by zone ID", "length": 255, @@ -23615,61 +23641,56 @@ "type": "uuid" }, { - "description": "list only source NAT IP addresses", + "description": "list only static NAT IP addresses", "length": 255, - "name": "issourcenat", + "name": "isstaticnat", "required": false, "type": "boolean" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "pagesize", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "lists all public IP addresses by source network ID", "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", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "since": "4.13.0", + "type": "uuid" }, { - "description": "List IPs belonging to the VPC", + "description": "lists IP address by ID", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "id", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "limits search results to allocated public IP addresses", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "allocatedonly", + "name": "retrieveonlyresourcecount", "required": false, "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "lists the specified IP address", "length": 255, - "name": "tags", + "name": "ipaddress", "required": false, - "type": "map" + "type": "string" }, { - "description": "", + "description": "limits search results to allocated public IP addresses", "length": 255, - "name": "page", + "name": "allocatedonly", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "lists all public IP addresses by state", @@ -23678,22 +23699,6 @@ "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": "lists all public IP addresses by VLAN ID", - "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -23702,72 +23707,61 @@ "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": "list only source NAT IP addresses", "length": 255, - "name": "listall", + "name": "issourcenat", "required": false, "type": "boolean" }, { - "description": "the virtual network for the IP address", + "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": "forvirtualnetwork", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "lists all public IP addresses associated to the network specified", + "description": "true if range is dedicated for system VMs", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "forsystemvms", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list only IPs used for load balancing", "length": 255, - "name": "fordisplay", + "name": "forloadbalancing", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "lists all public IP addresses by source network ID", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "account", "required": false, - "since": "4.13.0", - "type": "uuid" + "type": "string" }, { - "description": "lists IP address by ID", + "description": "", "length": 255, - "name": "id", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "true if range is dedicated for system VMs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "forsystemvms", + "name": "isrecursive", "required": false, - "since": "4.20.0", "type": "boolean" } ], "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { @@ -23776,54 +23770,13 @@ "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "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": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { @@ -23831,58 +23784,53 @@ "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": "path of the domain to which the public IP address belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", - "type": "string" - }, { "description": "the account the public IP address is associated with", "name": "account", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "public IP address id", + "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": "tag value", + "name": "value", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, { - "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -23891,8 +23839,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -23906,18 +23854,8 @@ "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", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], @@ -23929,28 +23867,39 @@ "type": "string" }, { - "description": "is public ip 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": "public IP address id", - "name": "id", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", "type": "boolean" }, + {}, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "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 physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -23958,31 +23907,82 @@ "name": "virtualmachinename", "type": "string" }, + { + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" + }, { "description": "the virtual network for the IP address", "name": "forvirtualnetwork", "type": "boolean" }, + {}, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { "description": "the name of the Network where ip belongs to", "name": "networkname", "type": "string" }, + { + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + { + "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": "is public IP portable across the zones", "name": "isportable", @@ -23994,24 +23994,24 @@ "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "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 project name of the address", - "name": "project", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", + "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": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" } ] }, @@ -24040,19 +24040,19 @@ "related": "addOpenDaylightController,deleteOpenDaylightController", "response": [ { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, + {}, { - "description": "the url of the controller api", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -24060,20 +24060,20 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "device id of the controller", "name": "id", "type": "string" }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the url of the controller api", + "name": "url", "type": "string" } ] @@ -24083,6 +24083,13 @@ "isasync": true, "name": "addBigSwitchBcfDevice", "params": [ + { + "description": "Username of the BigSwitch BCF Controller.", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, { "description": "Password of the BigSwitch BCF Controller.", "length": 255, @@ -24098,11 +24105,12 @@ "type": "string" }, { - "description": "Username of the BigSwitch BCF Controller.", + "description": "the Physical Network ID", "length": 255, - "name": "username", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { "description": "NAT support of the BigSwitch BCF Controller.", @@ -24110,28 +24118,10 @@ "name": "nat", "required": true, "type": "boolean" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": true, - "type": "uuid" } ], "related": "listBigSwitchBcfDevices", "response": [ - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "device name", - "name": "bigswitchdevicename", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -24148,13 +24138,18 @@ "type": "string" }, { - "description": "NAT support", - "name": "nat", - "type": "boolean" + "description": "device name", + "name": "bigswitchdevicename", + "type": "string" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "the controller password", + "name": "password", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -24162,18 +24157,23 @@ "name": "hostname", "type": "string" }, + {}, { - "description": "the controller password", - "name": "password", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, - {}, { "description": "the controller username", "name": "username", "type": "string" - } + }, + { + "description": "NAT support", + "name": "nat", + "type": "boolean" + }, + {} ], "since": "4.6.0" }, @@ -24183,33 +24183,123 @@ "name": "updateDefaultNicForVirtualMachine", "params": [ { - "description": "NIC ID", + "description": "Virtual Machine ID", "length": 255, - "name": "nicid", - "related": "listNics", + "name": "virtualmachineid", + "related": "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" }, { - "description": "Virtual Machine ID", + "description": "NIC ID", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "name": "nicid", + "related": "listNics", "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "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 the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "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": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "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", + "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 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 total number of network traffic bytes sent", @@ -24217,58 +24307,93 @@ "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "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": "device type of the root volume", - "name": "rootdevicetype", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "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 VM's disk read in KiB", - "name": "diskkbsread", + "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 optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -24277,100 +24402,306 @@ "type": "list" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "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", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the 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": "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 domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "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", + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "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 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" + }, + { + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the account owning the security group", + "name": "account", + "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 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": "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 code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "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 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", + "type": "integer" }, { - "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", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -24384,43 +24715,38 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "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 id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the protocol of the security group rule", "name": "protocol", @@ -24430,252 +24756,263 @@ "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 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 description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, { "description": "the project name of the group", "name": "project", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "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": "security group name", - "name": "securitygroupname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "account owning the security group rule", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "tag value", + "name": "value", "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": "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": "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": "set" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "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 domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "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 ID of the security group", - "name": "id", - "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 virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "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": "resource type", - "name": "resourcetype", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "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 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", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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" } ], "type": "set" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + {}, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { @@ -24683,43 +25020,13 @@ "name": "nic", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "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 ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -24728,34 +25035,39 @@ "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, { "description": "the netmask of the nic", "name": "netmask", "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 isolation uri of the nic", - "name": "isolationuri", + "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", + "description": "the name of the corresponding network", + "name": "networkname", "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", @@ -24763,13 +25075,13 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -24778,18 +25090,8 @@ "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": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -24798,250 +25100,142 @@ "type": "boolean" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, - { - "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": "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { "description": "the isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" - } - ], - "type": "set" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "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 domain name of the affinity group", - "name": "domain", - "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 project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the affinity group", + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "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", + "type": "list" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" } ], "type": "set" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "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 vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, - {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "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": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "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 vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "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 has delete protection.", @@ -25049,53 +25243,8 @@ "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "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": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { @@ -25103,193 +25252,44 @@ "name": "userdataname", "type": "string" }, - {}, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, - { - "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": " 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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "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": "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 format of the template for the virtual machine", - "name": "templateformat", + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" } ] @@ -25299,6 +25299,13 @@ "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, @@ -25306,59 +25313,52 @@ "related": "addCluster,updateCluster", "required": true, "type": "uuid" - }, - { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Type of DRS Plan (Automated or Manual))", "name": "type", "type": "type" }, { - "description": "Id of the cluster", - "name": "clusterid", - "type": "string" - }, - { - "description": "Start event Id of the DRS Plan", - "name": "eventid", - "type": "string" + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, + {}, { - "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": "List of migrations", - "name": "migrations", - "type": "list" + "description": "Id of the cluster", + "name": "clusterid", + "type": "string" }, { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" + "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": "Start event Id of the DRS Plan", + "name": "eventid", + "type": "string" } ], "since": "4.19.0" @@ -25379,27 +25379,27 @@ ], "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" - } + }, + { + "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" + }, + {} ] }, { @@ -25414,50 +25414,40 @@ "required": true, "type": "string" }, - { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", - "required": true, - "type": "uuid" - }, { "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 ID of the host", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ + {}, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", - "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 username", "name": "username", "type": "string" }, - {}, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, - { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, {}, { "description": "the out-of-band management action (if issued)", @@ -25465,38 +25455,48 @@ "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": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the operation result description", + "name": "description", "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 ID of the host", + "name": "hostid", + "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" } ], @@ -25508,12 +25508,11 @@ "name": "createSharedFileSystem", "params": [ { - "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", + "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "name": "filesystem", + "required": true, + "type": "string" }, { "description": "min iops", @@ -25523,47 +25522,42 @@ "type": "long" }, { - "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", + "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the description for the shared filesystem.", + "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": "description", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" - }, - { - "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 name of the shared filesystem.", + "description": "max iops", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "maxiops", + "required": false, + "type": "long" }, { - "description": "max iops", + "description": "the size of the shared filesystem in GiB", "length": 255, - "name": "maxiops", + "name": "size", "required": false, "type": "long" }, { - "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", + "description": "network to attach the shared filesystem to", "length": 255, - "name": "filesystem", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, - "type": "string" + "type": "uuid" }, { "description": "the provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API.", @@ -25573,27 +25567,34 @@ "type": "string" }, { - "description": "the zone id.", + "description": "the description for the shared filesystem.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "description", + "required": false, + "type": "string" + }, + { + "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 size of the shared filesystem in GiB", + "description": "the zone id.", "length": 255, - "name": "size", - "required": false, - "type": "long" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "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.", + "description": "the name of the shared filesystem.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { "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.", @@ -25604,60 +25605,38 @@ "type": "uuid" }, { - "description": "network to attach the shared filesystem to", + "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" } ], "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ - { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", - "type": "string" - }, { "description": "the write (IO) of disk on the shared filesystem", "name": "diskiowrite", "type": "long" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - {}, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { @@ -25666,19 +25645,19 @@ "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "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 state of the shared filesystem", + "name": "state", + "type": "string" }, { - "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": "size of the shared filesystem", @@ -25686,59 +25665,33 @@ "type": "long" }, { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", "type": "long" }, - { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, - { - "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": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { @@ -25747,99 +25700,87 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "tag value", - "name": "value", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" - } - ], - "type": "set" - }, - { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" - }, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "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 vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -25848,23 +25789,23 @@ "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": "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { @@ -25872,19 +25813,14 @@ "name": "isdefault", "type": "boolean" }, - { - "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": "Type of adapter if available", - "name": "adaptertype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -25893,137 +25829,196 @@ "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": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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 (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ID of the nic", + "name": "id", "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" - }, + } + ], + "type": "list" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "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 project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "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": "macaddress", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "customer associated with the tag", + "name": "customer", "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 isolation uri of the nic", - "name": "isolationuri", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], - "type": "list" + "type": "set" }, { - "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": "ID of the shared filesystem", - "name": "id", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { "description": "ID of the availability zone", @@ -26031,23 +26026,28 @@ "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" } ], @@ -26062,33 +26062,33 @@ "description": "Id of network device to delete", "length": 255, "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "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": "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" - }, + {}, {} ] }, @@ -26097,14 +26097,6 @@ "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": "The new name for the Image Store.", "length": 255, @@ -26125,48 +26117,52 @@ "name": "capacitybytes", "required": false, "type": "long" + }, + { + "description": "Image Store UUID", + "length": 255, + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": true, + "type": "uuid" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "defines if store is read-only", "name": "readonly", "type": "boolean" }, { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the protocol of the image store", "name": "protocol", "type": "string" }, - { - "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 scope of the image store", "name": "scope", "type": "scopetype" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { @@ -26175,19 +26171,24 @@ "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the ID of the image store", + "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 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 provider name of the image store", + "name": "providername", + "type": "string" }, {}, { @@ -26196,11 +26197,10 @@ "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.15.0" }, @@ -26213,29 +26213,28 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" }, { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75", + "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": "vmidipmap", + "name": "virtualmachineids", + "related": "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.4", - "type": "map" + "type": "list" }, { - "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", + "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75", "length": 255, - "name": "virtualmachineids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "name": "vmidipmap", "required": false, - "type": "list" + "since": "4.4", + "type": "map" } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -26256,6 +26255,7 @@ "name": "displaytext", "type": "string" }, + {}, {} ] }, @@ -26280,27 +26280,25 @@ "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": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The id of the management server", + "description": "", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "page", "required": false, - "since": "4.19", - "type": "uuid" + "type": "integer" }, { "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", @@ -26310,59 +26308,62 @@ "type": "date" }, { - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "description": "The id of the management server", "length": 255, - "name": "keyword", + "name": "managementserverid", + "related": "listManagementServers", "required": false, - "type": "string" + "since": "4.19", + "type": "uuid" } ], "related": "queryAsyncJobResult", "response": [ + {}, { - "description": "the domain id that executed the async command", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the account that executed the async command", "name": "account", "type": "string" }, { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" + "description": "the async command executed", + "name": "cmd", + "type": "string" }, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the user that executed the async command", "name": "userid", "type": "string" }, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "the domain that executed the async command", + "name": "domainpath", + "type": "string" }, { "description": "the progress information of the PENDING job", @@ -26370,60 +26371,59 @@ "type": "integer" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "the account id that executed the async command", + "name": "accountid", "type": "string" }, + { + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" + }, { "description": "the msid of the management server on which the job is running", "name": "managementserverid", "type": "long" }, { - "description": "the result type", - "name": "jobresulttype", - "type": "string" + "description": "the current job status-should be 0 for PENDING", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain that executed the async command", - "name": "domainpath", - "type": "string" + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" }, { - "description": "the account id that executed the async command", - "name": "accountid", - "type": "string" + "description": " the created date of the job", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id that executed the async command", + "name": "domainid", "type": "string" }, - {}, { - "description": "the async command executed", - "name": "cmd", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { - "description": " the created date of the job", - "name": "created", + "description": " the completed date of the job", + "name": "completed", "type": "date" }, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the result type", + "name": "jobresulttype", + "type": "string" } ] }, @@ -26433,36 +26433,42 @@ "name": "archiveAlerts", "params": [ { - "description": "the IDs of the alerts", + "description": "archive by alert type", "length": 255, - "name": "ids", - "related": "listAlerts,listAlertTypes", + "name": "type", "required": false, - "type": "list" + "type": "string" }, { - "description": "start date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "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": "startdate", + "name": "enddate", "required": false, "type": "date" }, { - "description": "archive by alert type", + "description": "the IDs of the alerts", "length": 255, - "name": "type", + "name": "ids", + "related": "listAlerts,listAlertTypes", "required": false, - "type": "string" + "type": "list" }, { - "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "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": "enddate", + "name": "startdate", "required": false, "type": "date" } ], "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", @@ -26473,18 +26479,12 @@ "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" - } + }, + {} ] }, { @@ -26502,27 +26502,27 @@ } ], "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" + "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" } ] }, @@ -26532,9 +26532,16 @@ "name": "createSecondaryStorageSelector", "params": [ { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "description": "The name identifying the heuristic rule.", "length": 255, - "name": "type", + "name": "name", + "required": true, + "type": "string" + }, + { + "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" }, @@ -26546,9 +26553,9 @@ "type": "string" }, { - "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", + "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" }, @@ -26559,33 +26566,26 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" - }, - { - "description": "The name identifying the heuristic rule.", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", "response": [ { - "description": "Description of the heuristic.", - "name": "description", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, { - "description": "When the heuristic was created.", - "name": "created", + "description": "When the heuristic was removed.", + "name": "removed", "type": "date" }, - {}, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "ID of the heuristic.", + "name": "id", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -26597,31 +26597,31 @@ "type": "string" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "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": "ID of the heuristic.", - "name": "id", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", "type": "string" }, - {}, { - "description": "Name of the heuristic.", - "name": "name", + "description": "Description of the heuristic.", + "name": "description", "type": "string" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", - "type": "string" + "description": "When the heuristic was created.", + "name": "created", + "type": "date" }, { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" - } + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", + "type": "string" + }, + {} ], "since": "4.19.0" }, @@ -26630,14 +26630,6 @@ "isasync": true, "name": "addBrocadeVcsDevice", "params": [ - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": true, - "type": "uuid" - }, { "description": "Credentials to access the Brocade VCS Switch API", "length": 255, @@ -26658,6 +26650,14 @@ "name": "hostname", "required": true, "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" } ], "related": "listBrocadeVcsDevices", @@ -26672,18 +26672,16 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the principal switch Ip address", + "name": "hostname", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -26694,11 +26692,13 @@ "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "the principal switch Ip address", - "name": "hostname", + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" - } + }, + {} ] }, { @@ -26706,13 +26706,6 @@ "isasync": true, "name": "deleteTags", "params": [ - { - "description": "Delete tags matching key/value pairs", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, { "description": "Delete tag by resource type", "length": 255, @@ -26726,30 +26719,37 @@ "name": "resourceids", "required": true, "type": "list" + }, + { + "description": "Delete tags matching key/value pairs", + "length": 255, + "name": "tags", + "required": false, + "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", + "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" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "4.0.0" @@ -26777,36 +26777,98 @@ ], "related": "listTungstenFabricTagType", "response": [ + { + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric tag type name", + "name": "name", + "type": "string" + }, { "description": "Tungsten-Fabric tag type uuid", "name": "uuid", "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 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" + }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Turn the network into a network with redundant routers.", + "length": 255, + "name": "makeredundant", + "required": false, + "since": "4.11.1", + "type": "boolean" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "If cleanup old network elements", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" }, + { + "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" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + {}, { - "description": "Tungsten-Fabric tag type name", - "name": "name", + "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" } ] @@ -26823,6 +26885,13 @@ "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, @@ -26836,51 +26905,44 @@ "name": "password", "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" } ], "related": "oauthlogin", "response": [ { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "user time zone", + "name": "timezone", "type": "string" }, { - "description": "User ID", - "name": "userid", + "description": "first name of the user", + "name": "firstname", "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": "Is two factor authentication enabled", - "name": "is2faenabled", - "type": "string" + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" }, { - "description": "Is user registered", - "name": "registered", + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" }, - {}, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", + "description": "User ID", + "name": "userid", "type": "string" }, + {}, { - "description": "user time zone", - "name": "timezone", + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" }, { @@ -26889,43 +26951,39 @@ "type": "string" }, { - "description": "first name of the user", - "name": "firstname", + "description": "Username", + "name": "username", "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, { - "description": "Username", - "name": "username", + "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": "Is two factor authentication verified", "name": "is2faverified", "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "last name of the user", + "name": "lastname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "description": "Is user registered", + "name": "registered", "type": "string" }, { @@ -26933,74 +26991,16 @@ "name": "type", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "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": "Turn the network into a network with redundant routers.", - "length": 255, - "name": "makeredundant", - "required": false, - "since": "4.11.1", - "type": "boolean" - }, - { - "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": "If cleanup old network elements", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" - }, - { - "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": "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": "user time zoneoffset", + "name": "timezoneoffset", "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" - }, - {} + } ] }, { @@ -27011,87 +27011,88 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "ID of the hypervisor capability", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the hypervisor for which to restrict the search", + "description": "", "length": 255, - "name": "hypervisor", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "ID of the hypervisor capability", "length": 255, - "name": "keyword", + "name": "id", + "related": "listHypervisorCapabilities", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ - {}, + { + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the maximum number of guest vms recommended for this hypervisor", "name": "maxguestslimit", "type": "long" }, - { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "string" - }, { "description": "true if security group is supported", "name": "securitygroupenabled", "type": "boolean" }, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", "type": "integer" }, + {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", - "type": "boolean" - }, { "description": "the maximum number of Hosts per cluster for this hypervisor", "name": "maxhostspercluster", "type": "integer" }, + {}, + { + "description": "the hypervisor type", + "name": "hypervisor", + "type": "string" + }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { "description": "true if storage motion is supported", @@ -27099,11 +27100,10 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the hypervisor capabilities row", + "name": "id", "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -27113,45 +27113,45 @@ "name": "deleteProjectRole", "params": [ { - "description": "ID of the project role to be deleted", + "description": "ID of the project from where the role is to be deleted", "length": 255, - "name": "id", - "related": "createProjectRole,listProjectRoles,updateProjectRole", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, "type": "uuid" }, { - "description": "ID of the project from where the role is to be deleted", + "description": "ID of the project role to be deleted", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createProjectRole,listProjectRoles,updateProjectRole", "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" }, - {} + { + "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.15.0" }, @@ -27170,28 +27170,28 @@ ], "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": "variable", "name": "variable", "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": "description", "name": "description", "type": "string" - }, - {} + } ], "since": "4.20" }, @@ -27201,11 +27201,12 @@ "name": "quotaBalance", "params": [ { - "description": "Start of the period of the Quota balance. 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.", + "description": "If domain Id is given and the caller is domain admin then the statement is generated for domain.", "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" }, { "description": "End of the period of the Quota balance.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.", @@ -27214,6 +27215,13 @@ "required": false, "type": "date" }, + { + "description": "Account Id for which statement needs to be generated", + "length": 255, + "name": "account", + "required": true, + "type": "string" + }, { "description": "List usage records for the specified account", "length": 255, @@ -27223,70 +27231,62 @@ "type": "uuid" }, { - "description": "If domain Id is given and the caller is domain admin then the statement is generated for domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": true, - "type": "uuid" - }, - { - "description": "Account Id for which statement needs to be generated", + "description": "Start of the period of the Quota balance. 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": "account", - "required": true, - "type": "string" + "name": "startdate", + "required": false, + "type": "date" } ], "related": "quotaStatement", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "usage type", - "name": "type", - "type": "int" + "description": "quota consumed", + "name": "quota", + "type": "bigdecimal" }, + {}, { - "description": "account id", - "name": "accountid", + "description": "domain id", + "name": "domain", "type": "long" }, + {}, { "description": "usage type name", "name": "name", "type": "string" }, { - "description": "quota consumed", - "name": "quota", - "type": "bigdecimal" + "description": "usage type", + "name": "type", + "type": "int" }, { - "description": "account name", - "name": "account", + "description": "usage unit", + "name": "unit", "type": "string" }, { - "description": "domain id", - "name": "domain", + "description": "account id", + "name": "accountid", "type": "long" }, { - "description": "usage unit", - "name": "unit", + "description": "account name", + "name": "account", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ], "since": "4.7.0" }, @@ -27312,6 +27312,11 @@ ], "related": "", "response": [ + { + "description": "SolidFire Account ID", + "name": "solidFireAccountId", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -27323,11 +27328,6 @@ "type": "string" }, {}, - { - "description": "SolidFire Account ID", - "name": "solidFireAccountId", - "type": "long" - }, {} ] }, @@ -27347,11 +27347,22 @@ ], "related": "", "response": [ + {}, { "description": "the description of the role permission", "name": "description", "type": "string" }, + { + "description": "the api name or wildcard rule", + "name": "rule", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the name of the role to which the role permission belongs", "name": "rolename", @@ -27362,33 +27373,22 @@ "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 permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" - }, { "description": "the ID of the role to which the role permission belongs", "name": "roleid", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" - } + }, + {} ], "since": "4.9.0" }, @@ -27398,26 +27398,27 @@ "name": "listDedicatedGuestVlanRanges", "params": [ { - "description": "zone of the guest VLAN range", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "project who will own the guest VLAN range", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", + "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": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "physical network id of the guest VLAN range", @@ -27428,113 +27429,112 @@ "type": "uuid" }, { - "description": "project who will own the guest VLAN range", + "description": "zone of the guest VLAN range", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "the dedicated guest vlan range", "length": 255, - "name": "pagesize", + "name": "guestvlanrange", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list dedicated guest vlan ranges by id", + "description": "", "length": 255, - "name": "id", - "related": "dedicateGuestVlanRange,listDedicatedGuestVlanRanges", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "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.", + "description": "list dedicated guest vlan ranges by id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "id", + "related": "dedicateGuestVlanRange,listDedicatedGuestVlanRanges", "required": false, "type": "uuid" }, { - "description": "the dedicated guest vlan range", + "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "guestvlanrange", + "name": "account", "required": false, "type": "string" } ], "related": "dedicateGuestVlanRange", "response": [ - {}, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, + {}, + { + "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", + "description": "the domain name of the guest VLAN range", + "name": "domain", "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": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the project id of the guest vlan range", + "name": "projectid", "type": "string" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, { - "description": "the project id of the guest vlan range", - "name": "projectid", + "description": "the project name of the guest vlan range", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "path of the domain to which the guest VLAN range belongs", - "name": "domainpath", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -27545,18 +27545,20 @@ "name": "listNetworkACLs", "params": [ { - "description": "list network ACL items by action", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "action", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "pagesize", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -27573,19 +27575,19 @@ "type": "string" }, { - "description": "list network ACL items by traffic type - ingress or egress", + "description": "list network ACL items by network ID", "length": 255, - "name": "traffictype", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -27595,95 +27597,88 @@ "type": "string" }, { - "description": "", + "description": "list network ACL items by action", "length": 255, - "name": "page", + "name": "action", "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 network ACL items by ACL ID", + "description": "Lists network ACL Item with the specified ID", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "id", + "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", "required": false, "type": "uuid" }, { - "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": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list network ACL items by traffic type - ingress or egress", "length": 255, - "name": "fordisplay", + "name": "traffictype", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "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": "tags", + "name": "listall", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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,moveDomain", "required": false, "type": "uuid" }, { - "description": "Lists network ACL Item with the specified ID", + "description": "", "length": 255, - "name": "id", - "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list network ACL items by network ID", + "description": "list network ACL items by ACL ID", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, "type": "uuid" } ], "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", "response": [ - { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" - }, {}, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { @@ -27692,13 +27687,14 @@ "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 ID of the ACL this item belongs to", - "name": "aclid", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { @@ -27707,8 +27703,13 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -27717,13 +27718,18 @@ "type": "string" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "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" }, { @@ -27741,28 +27747,28 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "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 key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -27771,44 +27777,38 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "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 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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, - {}, { - "description": "Number of the ACL Item", - "name": "number", + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -27822,12 +27822,12 @@ "name": "copyTemplate", "params": [ { - "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.", + "description": "ID of the zone the template is being copied to.", "length": 255, - "name": "destzoneids", + "name": "destzoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "list" + "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.", @@ -27837,33 +27837,63 @@ "required": false, "type": "uuid" }, - { - "description": "ID of the zone the template is being copied to.", - "length": 255, - "name": "destzoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "Template ID.", "length": 255, "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "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": "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": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "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": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "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 type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { @@ -27872,9 +27902,14 @@ "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "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", @@ -27882,44 +27917,44 @@ "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "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", - "type": "boolean" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { "description": "true if the template is managed across all Zones, false otherwise", @@ -27927,8 +27962,19 @@ "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "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": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { @@ -27937,14 +27983,30 @@ "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + {}, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { "description": "the account name to which the template belongs", @@ -27952,9 +28014,9 @@ "type": "string" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { "description": "the current status of the latest async job acting on this object", @@ -27962,53 +28024,42 @@ "type": "integer" }, { - "description": "the status of the template", - "name": "status", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "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 extractable, false otherwise", - "name": "isextractable", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, - {}, { "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 domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -28017,23 +28068,23 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -28042,67 +28093,46 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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" } ], "type": "set" }, - { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, { "description": "the format of the template.", "name": "format", "type": "imageformat" }, { - "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", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the template name", + "name": "name", + "type": "string" }, - {}, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { @@ -28111,89 +28141,59 @@ "type": "set" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the template ID", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "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", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "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", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "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 display text", - "name": "displaytext", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, { "description": "the id of userdata linked to this template", "name": "userdataid", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -28202,26 +28202,19 @@ "isasync": false, "name": "listNiciraNvpDeviceNetworks", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "nicira nvp device ID", @@ -28230,78 +28223,55 @@ "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": true, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "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", + "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the project id of the ipaddress", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "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": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { @@ -28310,59 +28280,53 @@ "type": "long" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, - {}, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { "description": "the ID of the Network associated with this private gateway", "name": "associatednetworkid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { @@ -28371,100 +28335,34 @@ "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "zone id of the network", + "name": "zoneid", "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": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "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 provider name", - "name": "name", - "type": "string" - }, - { - "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": "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" - } - ], - "type": "list" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "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": "the details of the network", @@ -28472,62 +28370,78 @@ "type": "map" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "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 routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + {}, + { + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -28536,13 +28450,13 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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" }, { @@ -28550,11 +28464,6 @@ "name": "value", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", @@ -28564,114 +28473,129 @@ "description": "customer associated with the tag", "name": "customer", "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" } ], "type": "list" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, - {}, { - "description": "the network's gateway", - "name": "gateway", + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", "type": "integer" }, + {}, { - "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": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { @@ -28680,53 +28604,134 @@ "type": "boolean" }, { - "description": "the type of the network", - "name": "type", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "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 network", + "name": "associatednetwork", "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 sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the network", - "name": "name", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "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 list of 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": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "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" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "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": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { @@ -28735,34 +28740,29 @@ "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "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 Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - }, - { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" } ] }, @@ -28781,27 +28781,27 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ], "since": "4.6.0" @@ -28812,33 +28812,34 @@ "name": "listOvsElements", "params": [ { - "description": "list network offerings by enabled state", + "description": "", "length": 255, - "name": "enabled", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "list ovs elements by network service provider id", "length": 255, - "name": "keyword", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list ovs elements by id", "length": 255, - "name": "page", + "name": "id", + "related": "listOvsElements,configureOvsElement", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list ovs elements by network service provider id", + "description": "List by keyword", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -28848,25 +28849,24 @@ "type": "integer" }, { - "description": "list ovs elements by id", + "description": "list network offerings by enabled state", "length": 255, - "name": "id", - "related": "listOvsElements,configureOvsElement", + "name": "enabled", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "configureOvsElement", "response": [ { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "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 provider belongs", - "name": "domainpath", + "description": "the id of the ovs", + "name": "id", "type": "string" }, { @@ -28874,9 +28874,10 @@ "name": "enabled", "type": "boolean" }, + {}, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { @@ -28885,36 +28886,35 @@ "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the ipaddress", + "name": "projectid", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain associated with the provider", + "name": "domain", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "the id of the ovs", - "name": "id", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" - }, - {} + } ] }, { @@ -28948,20 +28948,11 @@ ], "related": "", "response": [ - { - "description": "associated ucs profile dn", - "name": "profiledn", - "type": "string" - }, + {}, {}, { - "description": "ucs blade id", - "name": "id", - "type": "string" - }, - { - "description": "ucs blade dn", - "name": "bladedn", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" }, { @@ -28975,15 +28966,24 @@ "type": "string" }, { - "description": "cloudstack host id this blade associates to", - "name": "hostid", + "description": "ucs blade dn", + "name": "bladedn", + "type": "string" + }, + { + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "ucs blade id", + "name": "id", + "type": "string" } ] }, @@ -29001,6 +29001,11 @@ } ], "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", @@ -29012,17 +29017,12 @@ "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.18.0" }, @@ -29039,11 +29039,11 @@ "type": "string" }, { - "description": "The password for specified username.", + "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": "password", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "The username required to connect to resource.", @@ -29053,11 +29053,11 @@ "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": "VMware datacenter name.", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "The zone ID", @@ -29068,26 +29068,31 @@ "type": "uuid" }, { - "description": "VMware datacenter name.", + "description": "The password for specified username.", "length": 255, - "name": "name", + "name": "password", "required": false, "type": "string" } ], "related": "addVmwareDc,listVmwareDcs", "response": [ + {}, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "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 VMware vCenter name/ip", + "name": "vcenter", + "type": "string" + }, { "description": "The VMware Datacenter ID", "name": "id", @@ -29098,17 +29103,12 @@ "name": "name", "type": "string" }, - {}, { "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" - } + {} ], "since": "4.12.0" }, @@ -29117,13 +29117,6 @@ "isasync": false, "name": "getRouterHealthCheckResults", "params": [ - { - "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" - }, { "description": "the ID of the router", "length": 255, @@ -29131,15 +29124,20 @@ "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the router", + "name": "routerid", "type": "string" }, { @@ -29147,14 +29145,16 @@ "name": "healthchecks", "type": "list" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the id of the router", - "name": "routerid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -29165,13 +29165,6 @@ "isasync": false, "name": "listNetscalerControlCenter", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -29185,46 +29178,53 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ - { - "description": "username", - "name": "username", - "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": "ncc_ip", + "name": "ipaddress", + "type": "string" }, { "description": "num_retries", "name": "numretries", "type": "string" }, - {}, { "description": "id", "name": "id", "type": "string" }, { - "description": "ncc_ip", - "name": "ipaddress", + "description": "uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "uuid", - "name": "uuid", + "description": "username", + "name": "username", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ] }, @@ -29237,14 +29237,14 @@ "description": "the ID of the disk volume", "length": 255, "name": "id", - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "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": "New maximum number of IOPS", + "description": "New volume size in GB", "length": 255, - "name": "maxiops", + "name": "size", "required": false, "type": "long" }, @@ -29256,16 +29256,9 @@ "type": "boolean" }, { - "description": "New volume size in GB", - "length": 255, - "name": "size", - "required": false, - "type": "long" - }, - { - "description": "New minimum number of IOPS", + "description": "New maximum number of IOPS", "length": 255, - "name": "miniops", + "name": "maxiops", "required": false, "type": "long" }, @@ -29276,108 +29269,115 @@ "related": "createDiskOffering,listDiskOfferings", "required": false, "type": "uuid" + }, + { + "description": "New minimum number of IOPS", + "length": 255, + "name": "miniops", + "required": false, + "type": "long" } ], - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ + { + "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 date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "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 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 ISO attached to the virtual machine", - "name": "isoname", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "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": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "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", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "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 date the disk volume was created", - "name": "created", - "type": "date" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "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": "ID of the availability zone", - "name": "zoneid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { @@ -29386,39 +29386,45 @@ "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, + {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", - "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": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "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": "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": "the display text of the disk offering", @@ -29426,83 +29432,87 @@ "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "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": "min iops of the disk volume", - "name": "miniops", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, - {}, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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 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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -29511,197 +29521,187 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the path of the volume", + "name": "path", + "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": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "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 date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the ID of the domain associated with the disk volume", + "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": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "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": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "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", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, {}, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "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": "size of the disk volume", - "name": "size", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" } ] @@ -29712,12 +29712,11 @@ "name": "deleteAffinityGroup", "params": [ { - "description": "The ID of the affinity group. Mutually exclusive with name parameter", + "description": "The name of the affinity group. Mutually exclusive with ID parameter", "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the project of the affinity group", @@ -29728,18 +29727,19 @@ "type": "uuid" }, { - "description": "The name of the affinity group. Mutually exclusive with ID parameter", + "description": "the account of the affinity group. Must be specified with domain ID", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "the account of the affinity group. Must be specified with domain ID", + "description": "The ID of the affinity group. Mutually exclusive with name parameter", "length": 255, - "name": "account", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the domain ID of account owning the affinity group", @@ -29752,26 +29752,26 @@ ], "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -29791,162 +29791,183 @@ ], "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": "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" + } ], "since": "3.0.0" }, { - "description": "Dedicates a Pod.", + "description": "Update a Storage network IP range, only allowed when no IPs in this range have been allocated.", "isasync": true, - "name": "dedicatePod", + "name": "updateStorageNetworkIpRange", "params": [ { - "description": "the ID of the containing domain", + "description": "the beginning IP address", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": true, - "type": "uuid" + "name": "startip", + "required": false, + "type": "string" }, { - "description": "the ID of the Pod", + "description": "the netmask for storage network", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "netmask", + "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 name of the account which needs dedication. Must be used with domainId.", + "description": "the ending IP address", "length": 255, - "name": "account", + "name": "endip", "required": false, "type": "string" + }, + { + "description": "Optional. the vlan the ip range sits on", + "length": 255, + "name": "vlan", + "required": false, + "type": "integer" } ], - "related": "listDedicatedPods", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "response": [ { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, + {}, { - "description": "the Name of the Pod", - "name": "podname", + "description": "the gateway of the storage network IP range", + "name": "gateway", "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 netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the end ip of the storage network IP range", + "name": "endip", + "type": "string" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "integer" }, {}, { - "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 Zone uuid of the storage network IP range", + "name": "zoneid", + "type": "string" + } + ], + "since": "3.0.0" }, { - "description": "Update a Storage network IP range, only allowed when no IPs in this range have been allocated.", + "description": "Dedicates a Pod.", "isasync": true, - "name": "updateStorageNetworkIpRange", + "name": "dedicatePod", "params": [ { - "description": "UUID of storage network ip range", - "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the beginning IP address", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "startip", + "name": "account", "required": false, "type": "string" }, { - "description": "Optional. the vlan the ip range sits on", - "length": 255, - "name": "vlan", - "required": false, - "type": "integer" - }, - { - "description": "the ending IP address", + "description": "the ID of the containing domain", "length": 255, - "name": "endip", - "required": false, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" }, { - "description": "the netmask for storage network", + "description": "the ID of the Pod", "length": 255, - "name": "netmask", - "required": false, - "type": "string" + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" } ], - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "related": "listDedicatedPods", "response": [ { - "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 end ip of the storage network IP range", - "name": "endip", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the Name of the Pod", + "name": "podname", + "type": "string" + }, + { + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, { @@ -29955,44 +29976,23 @@ "type": "integer" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", - "type": "string" - }, - { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, - { - "description": "the start ip of the storage network IP range", - "name": "startip", - "type": "string" - }, - { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", - "type": "string" - }, {}, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the ID of the Pod", + "name": "podid", "type": "string" - }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" } - ], - "since": "3.0.0" + ] }, { "description": "Synchronize Tungsten-Fabric data", @@ -30009,9 +30009,15 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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" }, { @@ -30019,18 +30025,12 @@ "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" - }, - {} + } ] }, { @@ -30039,11 +30039,11 @@ "name": "purgeExpungedResources", "params": [ { - "description": "The type of the resource which need to be purged. Supported types: VirtualMachine", + "description": "The size of batch used during purging", "length": 255, - "name": "resourcetype", + "name": "batchsize", "required": false, - "type": "string" + "type": "long" }, { "description": "The end date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", @@ -30060,35 +30060,35 @@ "type": "date" }, { - "description": "The size of batch used during purging", + "description": "The type of the resource which need to be purged. Supported types: VirtualMachine", "length": 255, - "name": "batchsize", + "name": "resourcetype", "required": false, - "type": "long" + "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": "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.20" @@ -30098,25 +30098,11 @@ "isasync": true, "name": "changeOfferingForVolume", "params": [ - { - "description": "Verify OK to Shrink", - "length": 255, - "name": "shrinkok", - "required": false, - "type": "boolean" - }, - { - "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", - "length": 255, - "name": "automigrate", - "required": false, - "type": "boolean" - }, { "description": "the ID of the volume", "length": 255, "name": "id", - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "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" }, @@ -30136,11 +30122,11 @@ "type": "uuid" }, { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "Verify OK to Shrink", "length": 255, - "name": "maxiops", + "name": "shrinkok", "required": false, - "type": "long" + "type": "boolean" }, { "description": "New volume size in GB for the custom disk offering", @@ -30148,58 +30134,57 @@ "name": "size", "required": false, "type": "long" - } - ], - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "response": [ + }, { - "description": "max iops of the disk volume", + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, "name": "maxiops", + "required": false, "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, + "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", + "length": 255, + "name": "automigrate", + "required": false, + "type": "boolean" + } + ], + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "response": [ { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { @@ -30208,55 +30193,29 @@ "type": "map" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - {}, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the domain associated with the disk volume", @@ -30264,29 +30223,8 @@ "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the state of the disk volume", - "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { @@ -30295,13 +30233,13 @@ "type": "date" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { @@ -30310,112 +30248,88 @@ "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "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": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the path of the volume", + "name": "path", "type": "string" }, + {}, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the disk utilization", + "name": "utilization", "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": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -30424,56 +30338,96 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "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 project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { @@ -30482,53 +30436,69 @@ "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, + {}, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { @@ -30537,43 +30507,73 @@ "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "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": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "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": "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": "type of the virtual machine", - "name": "vmtype", + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "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": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "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", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" } ], @@ -30584,13 +30584,6 @@ "isasync": false, "name": "deleteLdapConfiguration", "params": [ - { - "description": "port", - "length": 255, - "name": "port", - "required": false, - "type": "integer" - }, { "description": "linked domain", "length": 255, @@ -30599,6 +30592,13 @@ "required": false, "type": "uuid" }, + { + "description": "port", + "length": 255, + "name": "port", + "required": false, + "type": "integer" + }, { "description": "Hostname", "length": 255, @@ -30609,17 +30609,16 @@ ], "related": "addLdapConfiguration,listLdapConfigurations", "response": [ - { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" - }, { "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", @@ -30632,10 +30631,11 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "port the ldap server is running on", + "name": "port", + "type": "int" + }, + {} ], "since": "4.2.0" }, @@ -30645,10 +30645,10 @@ "name": "createProjectRole", "params": [ { - "description": "creates a project role with this unique name", + "description": "The description of the Project role", "length": 255, - "name": "name", - "required": true, + "name": "description", + "required": false, "type": "string" }, { @@ -30660,18 +30660,18 @@ "type": "uuid" }, { - "description": "The description of the Project role", + "description": "creates a project role with this unique name", "length": 255, - "name": "description", - "required": false, + "name": "name", + "required": true, "type": "string" } ], "related": "listProjectRoles,updateProjectRole", "response": [ { - "description": "the ID of the role", - "name": "id", + "description": "the name of the role", + "name": "name", "type": "string" }, { @@ -30680,8 +30680,8 @@ "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "the description of the role", + "name": "description", "type": "string" }, { @@ -30690,22 +30690,22 @@ "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 description of the role", - "name": "description", + "description": "the ID of the role", + "name": "id", "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.15.0" }, @@ -30715,18 +30715,25 @@ "name": "createIpv6FirewallRule", "params": [ { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "cidrlist", + "name": "endport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "fordisplay", + "required": false, + "type": "boolean" + }, + { + "description": "the starting port of Ipv6 firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" }, { "description": "error code for this ICMP message", @@ -30735,6 +30742,13 @@ "required": false, "type": "integer" }, + { + "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 network of the VM the Ipv6 firewall rule will be created for", "length": 255, @@ -30744,11 +30758,11 @@ "type": "uuid" }, { - "description": "the ending port of Ipv6 firewall rule", + "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "endport", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { "description": "type of the ICMP message being sent", @@ -30758,86 +30772,45 @@ "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "fordisplay", - "required": false, - "type": "boolean" + "name": "protocol", + "required": true, + "type": "string" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "startport", - "required": false, - "type": "integer" - }, - { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "destcidrlist", + "name": "cidrlist", "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": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule", "response": [ { - "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 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 public port range", - "name": "publicport", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, - {}, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "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", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -30845,23 +30818,18 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -30870,18 +30838,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -30890,56 +30853,93 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "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" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "list" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "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", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "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", + "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + {}, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -30961,9 +30961,9 @@ "related": "cancelShutdown,prepareForShutdown,readyForShutdown", "response": [ { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { @@ -30971,27 +30971,27 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" + }, { "description": "The number of jobs in progress", "name": "pendingjobscount", "type": "long" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", "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": "long" - } + }, + {} ], "since": "4.19.0" }, @@ -31001,9 +31001,9 @@ "name": "updateNetwork", "params": [ { - "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", + "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": "ip6dns1", + "name": "ip6dns2", "required": false, "since": "4.18.0", "type": "string" @@ -31016,25 +31016,19 @@ "type": "boolean" }, { - "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": "Force update even if CIDR type is different", + "description": "network domain", "length": 255, - "name": "changecidr", + "name": "networkdomain", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the new name for the network", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "name", + "name": "privatemtu", "required": false, - "type": "string" + "since": "4.18.0", + "type": "integer" }, { "description": "network offering ID", @@ -31045,65 +31039,63 @@ "type": "uuid" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "sourcenatipaddress", + "name": "customid", "required": false, - "since": "4.19", + "since": "4.4", "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": "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": "dns1", + "name": "updateinsequence", "required": false, - "since": "4.18.0", - "type": "string" + "type": "boolean" }, { - "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", "length": 255, - "name": "ip6dns2", + "name": "guestvmcidr", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", + "description": "Setting this to true will cause a forced network update,", "length": 255, - "name": "dns2", + "name": "forced", "required": false, - "since": "4.18.0", - "type": "string" + "type": "boolean" }, { - "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": "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": "updateinsequence", + "name": "sourcenatipaddress", "required": false, - "type": "boolean" + "since": "4.19", + "type": "string" }, { - "description": "network domain", + "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": "networkdomain", + "name": "dns1", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "Setting this to true will cause a forced network update,", + "description": "Force update even if CIDR type is different", "length": 255, - "name": "forced", + "name": "changecidr", "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", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "customid", + "name": "displaynetwork", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { "description": "the new display text for the network", @@ -31112,13 +31104,6 @@ "required": false, "type": "string" }, - { - "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 ID of the network", "length": 255, @@ -31127,6 +31112,21 @@ "required": true, "type": "uuid" }, + { + "description": "the new name for the network", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "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": "MTU to be configured on the network VR's public facing interfaces", "length": 255, @@ -31136,30 +31136,102 @@ "type": "integer" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "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": "privatemtu", + "name": "ip6dns1", "required": false, "since": "4.18.0", - "type": "integer" + "type": "string" } ], "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "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" + }, + { + "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": "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { "description": "the first IPv6 DNS for the network", @@ -31167,84 +31239,161 @@ "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, + {}, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, { "description": "true if network supports specifying ip ranges, false otherwise", "name": "specifyipranges", "type": "boolean" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "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": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "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" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "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": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "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 date this network was created", - "name": "created", - "type": "date" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { "description": "The BGP peers for the network", @@ -31252,377 +31401,244 @@ "type": "set" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "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 offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "The external id of the network", + "name": "externalid", "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 id of the network", - "name": "id", + "description": "network offering id the network is created from", + "name": "networkofferingid", "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": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "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": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, - {}, { - "description": "the network domain", - "name": "networkdomain", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the 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" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "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", + "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": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the owner of the network", + "name": "account", + "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "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": "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": "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "zone id of the network", + "name": "zoneid", + "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "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 name of the network", "name": "name", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "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 vlan of the network. This parameter is visible to ROOT admins only", "name": "vlan", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + {}, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { @@ -31631,50 +31647,34 @@ "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "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": "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 first IPv4 DNS for the network", - "name": "dns1", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" } ] }, @@ -31690,28 +31690,28 @@ "name": "id", "type": "integer" }, + { + "description": "Usage type description", + "name": "description", + "type": "string" + }, {}, { "description": "Usage type name", "name": "name", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Usage type description", - "name": "description", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -31729,28 +31729,28 @@ } ], "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" - } + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ] }, { @@ -31759,458 +31759,178 @@ "name": "migrateVirtualMachine", "params": [ { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", "length": 255, - "name": "autoselect", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "uuid" }, { "description": "Destination Host ID to migrate VM to.", "length": 255, "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "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": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "autoselect", "required": false, + "since": "4.16.0", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "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": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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 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": "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": "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" - } - ], - "type": "set" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "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": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "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": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the VM's primary IP address", + "name": "ipaddress", "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 domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "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": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "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 project name of the affinity group", - "name": "project", - "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 vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", "name": "isdynamicallyscalable", "type": "boolean" }, { - "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 name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "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", + "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": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - {}, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "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": "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", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Guest vm Boot Type", + "name": "boottype", "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 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 domain name of the security group", "name": "domain", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "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 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 key name", + "name": "key", + "type": "string" + }, { "description": "tag value", "name": "value", @@ -32222,119 +31942,149 @@ "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": "the project name where tag belongs to", - "name": "project", + "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": "customer associated with the tag", "name": "customer", "type": "string" + } + ], + "type": "set" + }, + { + "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" + }, + { + "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": "tag key name", - "name": "key", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "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" - } - ], - "type": "set" - }, - { - "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "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": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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", + "description": "tag value", + "name": "value", "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", + "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" }, { - "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": "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 starting IP of the security group rule", "name": "startport", @@ -32344,44 +32094,14 @@ "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 code for the ICMP message response", - "name": "icmpcode", - "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": "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 ID of the security group", + "name": "id", + "type": "string" }, { "description": "the domain ID of the security group", @@ -32394,36 +32114,71 @@ "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "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 list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the 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 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": "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -32437,98 +32192,68 @@ "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", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", + "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", + "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 id of the security group rule", - "name": "ruleid", - "type": "string" } ], "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" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -32536,317 +32261,216 @@ "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "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 ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, + {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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 project id of the vm", - "name": "projectid", - "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": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", - "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": "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 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 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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the type of the nic", + "description": "the type of the affinity group", "name": "type", "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "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", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project name of the affinity group", + "name": "project", "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 domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], "type": "set" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, - {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { @@ -32855,74 +32479,450 @@ "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "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", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "VNF details", "name": "vnfdetails", "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the virtual machine", + "name": "name", "type": "string" - } - ] - }, - { - "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 project name of the vm", + "name": "project", + "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": "any text associated with the success or failure", - "name": "displaytext", + "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": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "true if operation is executed successfully", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "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": "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 user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + {}, + { + "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 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": "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + {}, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "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": "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": "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 gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "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 broadcast uri of the nic", + "name": "broadcasturi", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + } + ] + }, + { + "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": "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" + } ] }, { @@ -32931,18 +32931,18 @@ "name": "listBaremetalRct", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -32955,27 +32955,27 @@ "related": "addBaremetalRct", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of rct", + "name": "id", + "type": "string" }, + {}, { "description": "url", "name": "url", "type": "string" }, - { - "description": "id of rct", - "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" + } ] }, { @@ -32998,6 +32998,7 @@ "name": "name", "type": "string" }, + {}, { "description": "the description of the CA service provider", "name": "description", @@ -33008,13 +33009,12 @@ "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - {} + } ], "since": "4.11.0" }, @@ -33033,27 +33033,27 @@ } ], "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": "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" + }, {} ] }, @@ -33063,11 +33063,13 @@ "name": "listPortForwardingRules", "params": [ { - "description": "", + "description": "list port forwarding rules for certain network", "length": 255, - "name": "page", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "integer" + "since": "4.3", + "type": "uuid" }, { "description": "List by keyword", @@ -33077,66 +33079,65 @@ "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 only resources belonging to the domain specified", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule", "required": false, "type": "uuid" }, { - "description": "list port forwarding rules for certain network", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "tags", "required": false, - "since": "4.3", - "type": "uuid" + "type": "map" }, { - "description": "Lists rule with the specified ID.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "fordisplay", + "name": "listall", "required": false, - "since": "4.4", "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "tags", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "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 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 IP address of the port forwarding services", "length": 255, @@ -33146,88 +33147,41 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule", "response": [ - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, {}, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, { "description": "the VM display name for the port forwarding rule", "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - {}, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "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 VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { @@ -33235,71 +33189,106 @@ "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": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "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", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "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 ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { @@ -33308,14 +33297,25 @@ "type": "integer" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { "description": "the vm ip address for the port forwarding rule", "name": "vmguestip", "type": "string" + }, + {}, + { + "description": "the state of the rule", + "name": "state", + "type": "string" } ] }, @@ -33343,36 +33343,30 @@ ], "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": "Gateway for Pod ", + "name": "gateway", "type": "string" }, { - "description": "the ID of the pod the IP address belongs to", - "name": "podid", + "description": "the ID of the nic", + "name": "nicid", "type": "long" }, - {}, { "description": "the ID of the pod the IP address", "name": "id", "type": "long" }, + {}, { - "description": "Allocated IP address", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the nic", - "name": "nicid", + "description": "the ID of the pod the IP address belongs to", + "name": "podid", "type": "long" }, { @@ -33380,15 +33374,21 @@ "name": "cidr", "type": "string" }, + { + "description": "Allocated IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "MAC address of the pod the IP", "name": "hostmac", "type": "long" - }, - { - "description": "Gateway for Pod ", - "name": "gateway", - "type": "string" } ] }, @@ -33408,11 +33408,15 @@ ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ - {}, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + { + "description": "the operation result description", + "name": "description", + "type": "string" }, { "description": "the out-of-band management interface powerState of the host", @@ -33420,34 +33424,34 @@ "type": "powerstate" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "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": "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 out-of-band management interface username", + "name": "username", "type": "string" }, { - "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 out-of-band management interface username", - "name": "username", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, {}, { - "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" }, { @@ -33456,24 +33460,20 @@ "type": "string" }, { - "description": "the operation result description", - "name": "description", + "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" + }, { "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 port", - "name": "port", - "type": "string" } ], "since": "4.9.0" @@ -33484,41 +33484,27 @@ "name": "updateTemplatePermissions", "params": [ { - "description": "true for featured template/iso, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" - }, - { - "description": "true for public template/iso, false for private templates/isos", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, - { - "description": "permission operator (add, remove, reset)", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "op", + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "list" }, { "description": "the template ID", "length": 255, "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "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 projects. If specified, \"op\" parameter has to be passed in.", + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "isextractable", "required": false, - "type": "list" + "type": "boolean" }, { "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", @@ -33528,14 +33514,33 @@ "type": "list" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "description": "permission operator (add, remove, reset)", "length": 255, - "name": "isextractable", + "name": "op", + "required": false, + "type": "string" + }, + { + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "true for featured template/iso, false otherwise", + "length": 255, + "name": "isfeatured", "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", @@ -33548,11 +33553,6 @@ "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", @@ -33577,301 +33577,236 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, { "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the project name of the affinity group", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "path of the Domain the affinity group belongs to", + "description": "path of the Domain associated with the tag", "name": "domainpath", "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "device type of the root volume", + "name": "rootdevicetype", "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": "resource type", - "name": "resourcetype", + "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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 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": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + {}, + { + "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", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, - {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "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 userdata used for the VM", - "name": "userdataid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { @@ -33879,27 +33814,56 @@ "name": "zoneid", "type": "string" }, - {}, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, { "description": "the memory used by the VM in KiB", "name": "memorykbs", @@ -33911,13 +33875,33 @@ "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "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 VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { @@ -33925,79 +33909,136 @@ "name": "userdatapolicy", "type": "string" }, + {}, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "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": "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 name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, { "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the user's ID who deployed the virtual machine", "name": "userid", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "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 type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -34005,63 +34046,48 @@ "name": "nic", "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the nic", + "name": "id", "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": "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": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "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 ip address of the nic", - "name": "ipaddress", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -34070,106 +34096,121 @@ "type": "boolean" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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 Secondary ipv4 addr of nic", - "name": "secondaryip", + "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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 netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the type of the nic", + "name": "type", "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 isolation uri of the nic", - "name": "isolationuri", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "type": "set" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { @@ -34178,64 +34219,104 @@ "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "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 group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", + "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "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 name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { "description": "list of security groups associated with the virtual machine", @@ -34247,32 +34328,37 @@ "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "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 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 starting IP of the security group rule", - "name": "startport", + "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 id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -34280,48 +34366,33 @@ "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 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", + "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": "tag key name", - "name": "key", + "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" }, { @@ -34330,8 +34401,8 @@ "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" }, { @@ -34340,8 +34411,18 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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" } ], @@ -34353,46 +34434,36 @@ "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": "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 id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "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 project name of the group", "name": "project", "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", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -34400,8 +34471,8 @@ "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" }, { @@ -34410,18 +34481,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "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" }, { @@ -34435,69 +34506,89 @@ "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": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, - { - "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 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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the 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", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -34505,14 +34596,19 @@ "name": "resourcetype", "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", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -34520,160 +34616,64 @@ "name": "resourceid", "type": "string" }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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 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 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" } ], "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 project id of the group", + "name": "projectid", + "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 name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - {}, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "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 ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" } ] }, @@ -34683,39 +34683,39 @@ "name": "listBrocadeVcsDevices", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Brocade VCS switch ID", + "description": "the Physical Network ID", "length": 255, - "name": "vcsdeviceid", - "related": "listBrocadeVcsDevices", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "Brocade VCS switch ID", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "vcsdeviceid", + "related": "listBrocadeVcsDevices", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -34723,13 +34723,14 @@ "related": "", "response": [ { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "brocadedevicename", "type": "string" }, + {}, { - "description": "device name", - "name": "brocadedevicename", + "description": "the principal switch Ip address", + "name": "hostname", "type": "string" }, { @@ -34738,25 +34739,24 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the principal switch Ip address", - "name": "hostname", + "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": "name of the provider", - "name": "provider", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "type": "string" } ] @@ -34766,6 +34766,13 @@ "isasync": false, "name": "linkDomainToLdap", "params": [ + { + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "domain admin username in LDAP ", "length": 255, @@ -34795,13 +34802,6 @@ "required": true, "type": "integer" }, - { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "name of the group or OU in LDAP", "length": 255, @@ -34813,18 +34813,25 @@ "related": "linkAccountToLdap", "response": [ { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" }, + {}, + {}, { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", "type": "string" }, { @@ -34832,26 +34839,19 @@ "name": "accounttype", "type": "int" }, - { - "description": "Domain Admin accountId that is created", - "name": "accountid", - "type": "string" - }, { "description": "id of the Domain which is linked to LDAP", "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 group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", + "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" } ], @@ -34863,11 +34863,12 @@ "name": "setupUserTwoFactorAuthentication", "params": [ { - "description": "Enabled by default, provide false to disable 2FA", + "description": "optional: the id of the user for which 2FA has to be disabled", "length": 255, - "name": "enable", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "two factor authentication code", @@ -34877,35 +34878,30 @@ "type": "string" }, { - "description": "optional: the id of the user for which 2FA has to be disabled", + "description": "Enabled by default, provide false to disable 2FA", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "enable", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "", "response": [ { - "description": "secret code that needs to be registered with authenticator", - "name": "secretcode", + "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 account ID of the user", - "name": "accountid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { @@ -34913,10 +34909,14 @@ "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "secret code that needs to be registered with authenticator", + "name": "secretcode", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" } ], @@ -34927,6 +34927,13 @@ "isasync": false, "name": "listVpnCustomerGateways", "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 only resources belonging to the domain specified", "length": 255, @@ -34944,11 +34951,11 @@ "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 by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", @@ -34958,19 +34965,19 @@ "type": "integer" }, { - "description": "id of the customer gateway", + "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", - "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "id of the customer gateway", "length": 255, - "name": "keyword", + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -34979,13 +34986,6 @@ "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": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -34997,69 +34997,85 @@ "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "response": [ { - "description": "the domain name of the owner", - "name": "domain", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, + {}, { "description": "the vpn gateway ID", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, {}, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "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", + "type": "string" }, { "description": "the owner", "name": "account", "type": "string" }, + { + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" + }, { "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 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 domain id of the owner", - "name": "domainid", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { @@ -35068,34 +35084,29 @@ "type": "boolean" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "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": "the project name", - "name": "project", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "Lifetime of IKE SA of customer gateway", @@ -35103,19 +35114,8 @@ "type": "long" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", - "type": "string" - }, - {}, - { - "description": "name of the customer gateway", - "name": "name", - "type": "string" - }, - { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the domain name of the owner", + "name": "domain", "type": "string" } ] @@ -35126,12 +35126,12 @@ "name": "deleteKubernetesCluster", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" + "name": "expunge", + "required": false, + "since": "4.19.0", + "type": "boolean" }, { "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", @@ -35142,12 +35142,12 @@ "type": "boolean" }, { - "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "expunge", - "required": false, - "since": "4.19.0", - "type": "boolean" + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" } ], "response": [ @@ -35157,21 +35157,21 @@ "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -35181,25 +35181,25 @@ "name": "listWebhooks", "params": [ { - "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": "", + "description": "The name of the Webhook", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "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": "", @@ -35209,32 +35209,33 @@ "type": "integer" }, { - "description": "The scope of the Webhook", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "scope", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The state of the Webhook", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "state", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The name of the Webhook", + "description": "The state of the Webhook", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "The ID of the Webhook", @@ -35253,47 +35254,25 @@ "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": "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,createProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "createWebhook,listWebhookDeliveries", "response": [ { - "description": "The secret key for the Webhook", - "name": "secretkey", - "type": "string" - }, - {}, - { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", - "type": "string" - }, - { - "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 project id of the Kubernetes cluster", - "name": "projectid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { @@ -35306,25 +35285,29 @@ "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 state of the Webhook", - "name": "state", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { - "description": "The name of the domain in which the Webhook exists", - "name": "domain", + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" + }, + { + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { @@ -35338,13 +35321,18 @@ "type": "string" }, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", + "description": "The name of the Webhook", + "name": "name", "type": "string" }, { - "description": "The scope of the Webhook", - "name": "scope", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -35352,10 +35340,22 @@ "name": "sslverification", "type": "boolean" }, + {}, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" + "description": "The state of the Webhook", + "name": "state", + "type": "string" + }, + {}, + { + "description": "The scope of the Webhook", + "name": "scope", + "type": "string" + }, + { + "description": "The secret key for the Webhook", + "name": "secretkey", + "type": "string" } ], "since": "4.20.0" @@ -35366,27 +35366,34 @@ "name": "createGlobalLoadBalancerRule", "params": [ { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "length": 255, + "name": "gslbstickysessionmethodname", "required": false, "type": "string" }, { - "description": "the domain ID associated with the load balancer", + "description": "name of the load balancer rule", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "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": "gslbstickysessionmethodname", + "name": "gslblbmethod", "required": false, "type": "string" }, + { + "description": "the domain ID associated with the load balancer", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, { "description": "region where the global load balancer is going to be created.", "length": 255, @@ -35403,30 +35410,23 @@ "type": "string" }, { - "description": "name of the load balancer rule", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "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": "gslblbmethod", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" }, { - "description": "domain name for the GSLB service.", + "description": "GSLB service type (tcp, udp, http)", "length": 255, - "name": "gslbdomainname", + "name": "gslbservicetype", "required": true, "type": "string" }, { - "description": "GSLB service type (tcp, udp, http)", + "description": "domain name for the GSLB service.", "length": 255, - "name": "gslbservicetype", + "name": "gslbdomainname", "required": true, "type": "string" } @@ -35434,34 +35434,28 @@ "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "response": [ { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", - "type": "string" - }, - {}, - { - "description": "the account of the load balancer rule", - "name": "account", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "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": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, { @@ -35470,8 +35464,8 @@ "type": "string" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -35479,44 +35473,48 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, - { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, { "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", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { @@ -35525,33 +35523,33 @@ "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "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 id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the private port", - "name": "privateport", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the public port", + "name": "publicport", "type": "string" }, { @@ -35559,8 +35557,13 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -35569,8 +35572,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -35589,13 +35592,8 @@ "type": "string" }, { - "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" }, { @@ -35604,21 +35602,21 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the public port", - "name": "publicport", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { @@ -35626,21 +35624,6 @@ "name": "domainpath", "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", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the name of the zone the load balancer rule belongs to", "name": "zonename", @@ -35652,8 +35635,13 @@ "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 guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -35664,19 +35652,30 @@ ], "type": "list" }, + {}, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "GSLB service type", + "name": "gslbservicetype", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { @@ -35684,9 +35683,10 @@ "name": "gslbdomainname", "type": "string" }, + {}, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" } ] @@ -35707,10 +35707,11 @@ ], "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", @@ -35721,13 +35722,12 @@ "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" - }, - {}, - {} + } ] }, { @@ -35736,19 +35736,11 @@ "name": "listTags", "params": [ { - "description": "list by resource type", - "length": 255, - "name": "resourcetype", - "required": false, - "type": "string" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list by value", @@ -35758,33 +35750,32 @@ "type": "string" }, { - "description": "", + "description": "list by customer name", "length": 255, - "name": "pagesize", + "name": "customer", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list by customer name", + "description": "list by resource id", "length": 255, - "name": "customer", + "name": "resourceid", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list by key", @@ -35794,11 +35785,12 @@ "type": "string" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -35808,37 +35800,40 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "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 by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list by resource id", + "description": "list by resource type", "length": 255, - "name": "resourceid", + "name": "resourcetype", "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" } ], "related": "listResourceDetails", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -35846,35 +35841,34 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "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 account associated with the tag", - "name": "account", + "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" }, { @@ -35883,21 +35877,27 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, + {}, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, - {}, { "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" - } + }, + {} ], "since": "4.0.0" }, @@ -35917,7 +35917,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -35930,22 +35930,27 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "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" } ], "related": "", "response": [ + { + "description": "the type of VM", + "name": "type", + "type": "string" + }, { "description": "the cluster ID for the VM", "name": "clusterid", @@ -35956,12 +35961,6 @@ "name": "hostname", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the ID of the VM", "name": "id", @@ -35972,26 +35971,27 @@ "name": "clustername", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the name of the VM", "name": "name", "type": "string" }, + {}, { - "description": "the type of VM", - "name": "type", - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.19.1" @@ -36021,19 +36021,13 @@ "related": "configureVirtualRouterElement,listVirtualRouterElements", "response": [ { - "description": "the id of the router", - "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": "the domain associated with the provider", - "name": "domain", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { @@ -36042,8 +36036,8 @@ "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the id of the router", + "name": "id", "type": "string" }, { @@ -36052,30 +36046,36 @@ "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "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 domain associated with the provider", + "name": "domain", "type": "string" }, + {}, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, + {}, { "description": "path of the domain to which the provider belongs", "name": "domainpath", "type": "string" }, - {}, { "description": "the domain ID associated with the provider", "name": "domainid", "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" } ] }, @@ -36085,27 +36085,10 @@ "name": "createVPC", "params": [ { - "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": "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 second IPv6 DNS for the VPC", + "description": "VPC network domain. All networks inside the VPC will belong to this domain", "length": 255, - "name": "ip6dns2", + "name": "networkdomain", "required": false, - "since": "4.18.0", "type": "string" }, { @@ -36124,17 +36107,18 @@ "type": "string" }, { - "description": "The display text of the VPC, defaults to its 'name'.", + "description": "the name of the VPC", "length": 255, - "name": "displaytext", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "VPC network domain. All networks inside the VPC will belong to this domain", + "description": "the first IPv4 DNS for the VPC", "length": 255, - "name": "networkdomain", + "name": "dns1", "required": false, + "since": "4.18.0", "type": "string" }, { @@ -36146,53 +36130,60 @@ "type": "uuid" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "the second IPv6 DNS for the VPC", "length": 255, - "name": "publicmtu", + "name": "ip6dns2", "required": false, "since": "4.18.0", - "type": "integer" + "type": "string" }, { - "description": "the AS Number of the VPC tiers", + "description": "the first IPv6 DNS for the VPC", "length": 255, - "name": "asnumber", + "name": "ip6dns1", "required": false, - "since": "4.20.0", - "type": "long" + "since": "4.18.0", + "type": "string" }, { - "description": "the account associated with the VPC. Must be used with the domainId parameter.", + "description": "the second IPv4 DNS for the VPC", "length": 255, - "name": "account", + "name": "dns2", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "dns1", + "name": "fordisplay", "required": false, - "since": "4.18.0", - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "Ids of the Bgp Peer for the VPC", + "description": "The display text of the VPC, defaults to its 'name'.", "length": 255, - "name": "bgppeerids", - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "name": "displaytext", "required": false, - "since": "4.20.0", - "type": "list" + "type": "string" }, { - "description": "the ID of the VPC offering", + "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": "vpcofferingid", - "related": "updateVPCOffering,listVPCOfferings", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, "type": "uuid" }, + { + "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": "create VPC for the project", "length": 255, @@ -36202,89 +36193,104 @@ "type": "uuid" }, { - "description": "the second IPv4 DNS for the VPC", + "description": "the account associated with the VPC. Must be used with the domainId parameter.", "length": 255, - "name": "dns2", + "name": "account", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "the CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.", + "description": "the AS Number of the VPC tiers", "length": 255, - "name": "cidrsize", + "name": "asnumber", "required": false, "since": "4.20.0", - "type": "integer" + "type": "long" }, { - "description": "the first IPv6 DNS for the VPC", + "description": "the ID of the VPC offering", "length": 255, - "name": "ip6dns1", + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "publicmtu", "required": false, "since": "4.18.0", - "type": "string" + "type": "integer" }, { - "description": "the name of the VPC", + "description": "Ids of the Bgp Peer for the VPC", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "required": false, + "since": "4.20.0", + "type": "list" }, { - "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.", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "sourcenatipaddress", "required": false, - "type": "uuid" + "since": "4.19", + "type": "string" } ], "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, + {}, { - "description": "the owner of the VPC", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", - "type": "string" + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "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 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": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { "description": "the physical network this belongs to", @@ -36292,18 +36298,18 @@ "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": "the provider name", - "name": "name", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -36312,25 +36318,30 @@ "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the provider name", + "name": "name", + "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", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "the capability name", + "name": "name", "type": "string" }, { @@ -36344,54 +36355,55 @@ ], "type": "list" }, + {}, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", - "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 second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" }, { - "description": "the id of the VPC", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", + "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { @@ -36400,114 +36412,57 @@ "type": "string" }, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" + "description": "the name of the VPC", + "name": "name", + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, - {}, - { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the name of the VPC", - "name": "name", - "type": "string" - }, - { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "description": "true VPC requires restart", - "name": "restartrequired", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - {}, { "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "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" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -36516,8 +36471,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -36526,8 +36481,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -36536,41 +36491,86 @@ "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", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" } ] @@ -36604,26 +36604,26 @@ ], "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": "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" } ] }, @@ -36633,26 +36633,26 @@ "name": "listOsTypes", "params": [ { - "description": "list by Os type Id", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.18.1", + "type": "boolean" }, { - "description": "", + "description": "list os by description", "length": 255, - "name": "page", + "name": "description", "required": false, - "type": "integer" + "since": "3.0.1", + "type": "string" }, { - "description": "list os by description", + "description": "List by keyword", "length": 255, - "name": "description", + "name": "keyword", "required": false, - "since": "3.0.1", "type": "string" }, { @@ -36663,19 +36663,19 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "list by Os type Id", "length": 255, - "name": "keyword", + "name": "id", + "related": "listOsTypes,addGuestOs", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.18.1", - "type": "boolean" + "type": "integer" }, { "description": "list by Os Category id", @@ -36688,53 +36688,53 @@ ], "related": "addGuestOs", "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 ID of the OS category", "name": "oscategoryid", "type": "string" }, { - "description": "the ID of the OS type", - "name": "id", - "type": "string" - }, - { - "description": "the name of the OS category", - "name": "oscategoryname", - "type": "string" + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" }, { "description": "the name/description of the OS type", "name": "description", "type": "string" }, + {}, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "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 name of the OS type", "name": "name", "type": "string" }, - {} + { + "description": "the ID of the OS type", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -36752,27 +36752,27 @@ } ], "response": [ + {}, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { "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.4.0" @@ -36794,176 +36794,467 @@ "description": "The ID of the virtual machine", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, { "description": "the type of the template for the virtual machine", "name": "templatetype", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project id of the group", - "name": "projectid", + "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 domain name of the security group", - "name": "domain", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the ID of the security group", + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "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": "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": "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": "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 gateway of the nic", + "name": "gateway", + "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 vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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 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 ip address of the nic", + "name": "ipaddress", + "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": "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 type of the nic", + "name": "type", "type": "string" }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "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": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + {}, + { + "description": "the state of the virtual machine", + "name": "state", + "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 name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "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 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": "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": "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" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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", + "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": "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 protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the 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" }, { @@ -36971,18 +37262,18 @@ "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", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -36991,33 +37282,33 @@ "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 key name", - "name": "key", + "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" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "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", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -37029,21 +37320,26 @@ "type": "set" }, { - "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": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -37051,17 +37347,109 @@ "name": "account", "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": "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": "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" + }, + { + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "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", + "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -37070,8 +37458,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -37080,8 +37473,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -37090,13 +37483,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -37105,41 +37493,31 @@ "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": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "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 ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -37148,8 +37526,13 @@ "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -37158,85 +37541,96 @@ "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" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", - "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" } ], "type": "set" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, + {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "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 account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "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": "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", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { "description": "path of the domain in which the virtual machine exists", @@ -37244,58 +37638,68 @@ "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "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", + "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 name of userdata used for the VM", + "name": "userdataname", "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 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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "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": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "VNF details", + "name": "vnfdetails", + "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", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { @@ -37304,38 +37708,58 @@ "type": "integer" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -37343,28 +37767,18 @@ "name": "affinitygroup", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", - "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", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { @@ -37372,14 +37786,19 @@ "name": "virtualmachineIds", "type": "list" }, + { + "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 project name of the affinity group", - "name": "project", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { @@ -37388,509 +37807,90 @@ "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "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 domain name of the affinity group", + "name": "domain", + "type": "string" } ], "type": "set" }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "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": "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": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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 ID of the corresponding network", - "name": "networkid", - "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 ID of the nic", - "name": "id", - "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 if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", - "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 gateway of IPv6 network", - "name": "ip6gateway", - "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - {}, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "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": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "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 domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - {}, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "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": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "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 domain in which the virtual machine exists", - "name": "domainid", - "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - {}, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "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": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" } ] }, @@ -37909,28 +37909,28 @@ } ], "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ] }, { @@ -37946,31 +37946,31 @@ "type": "boolean" }, { - "description": "Payload of the Webhook delivery", + "description": "The ID of the Webhook delivery for redelivery", "length": 255, - "name": "payload", + "name": "id", + "related": "executeWebhookDelivery", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Payload URL of the Webhook delivery", + "description": "Payload of the Webhook delivery", "length": 255, - "name": "payloadurl", + "name": "payload", "required": false, "type": "string" }, { - "description": "The ID of the Webhook delivery for redelivery", + "description": "Secret key of the Webhook delivery", "length": 255, - "name": "id", - "related": "executeWebhookDelivery", + "name": "secretkey", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Secret key of the Webhook delivery", + "description": "Payload URL of the Webhook delivery", "length": 255, - "name": "secretkey", + "name": "payloadurl", "required": false, "type": "string" }, @@ -37985,40 +37985,36 @@ ], "related": "", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "The start time of the Webhook delivery", "name": "startdate", "type": "date" }, - { - "description": "The headers of the webhook delivery", - "name": "headers", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "The end time of the Webhook delivery", "name": "enddate", "type": "date" }, { - "description": "The name of the Webhook", - "name": "webhookname", + "description": "The payload of the webhook delivery", + "name": "payload", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The headers of the webhook delivery", + "name": "headers", "type": "string" }, { - "description": "The ID of the Webhook", - "name": "webhookid", + "description": "The response of the webhook delivery", + "name": "response", "type": "string" }, { @@ -38027,11 +38023,15 @@ "type": "string" }, { - "description": "The payload of the webhook delivery", - "name": "payload", + "description": "The name of the management server which executed delivery", + "name": "managementservername", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "The ID of the Webhook delivery", "name": "id", @@ -38043,9 +38043,9 @@ "type": "string" }, { - "description": "The response of the webhook delivery", - "name": "response", - "type": "string" + "description": "Whether Webhook delivery succeeded or not", + "name": "success", + "type": "boolean" }, { "description": "The type of the event", @@ -38053,13 +38053,13 @@ "type": "string" }, { - "description": "Whether Webhook delivery succeeded or not", - "name": "success", - "type": "boolean" + "description": "The ID of the Webhook", + "name": "webhookid", + "type": "string" }, { - "description": "The name of the management server which executed delivery", - "name": "managementservername", + "description": "The name of the Webhook", + "name": "webhookname", "type": "string" } ], @@ -38080,6 +38080,8 @@ } ], "response": [ + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -38090,7 +38092,6 @@ "name": "success", "type": "boolean" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -38100,8 +38101,7 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -38126,81 +38126,81 @@ { "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createTungstenFabricProvider", "response": [ { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", "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 port", - "name": "tungstenproviderport", + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", "type": "string" }, - { - "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", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", "type": "string" }, + {}, + {}, { "description": "Tungsten-Fabric provider hostname", "name": "tungstenproviderhostname", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", + "description": "Tungsten-Fabric provider name", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" } ] @@ -38210,13 +38210,6 @@ "isasync": false, "name": "listDeploymentPlanners", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -38230,6 +38223,13 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", @@ -38240,7 +38240,6 @@ "type": "string" }, {}, - {}, { "description": "Deployment Planner name", "name": "name", @@ -38250,7 +38249,8 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -38268,18 +38268,17 @@ } ], "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 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", @@ -38289,7 +38288,8 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -38301,36 +38301,47 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ + {}, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Zone ID of the host", + "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 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": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { @@ -38339,69 +38350,95 @@ "type": "long" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "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": "capabilities of the host", - "name": "capabilities", + "description": "the host version", + "name": "version", "type": "string" }, + { + "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 amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + {}, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", @@ -38409,18 +38446,18 @@ "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { @@ -38429,48 +38466,93 @@ "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "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 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", + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "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", + "type": "string" + }, + { + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", "type": "date" }, { - "description": "the host version", - "name": "version", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "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 Pod name of the host", - "name": "podname", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { @@ -38478,14 +38560,54 @@ "name": "cpuallocated", "type": "string" }, + { + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" + }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, { "description": "Host details in key/value pairs.", "name": "details", "type": "map" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { @@ -38497,8 +38619,13 @@ "name": "vgpu", "response": [ { - "description": "Maximum displays per user", - "name": "maxheads", + "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" }, { @@ -38507,33 +38634,28 @@ "type": "string" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "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" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" } ], @@ -38548,70 +38670,9 @@ "type": "list" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, - {}, - { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the host", - "name": "name", - "type": "string" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", @@ -38619,85 +38680,24 @@ "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, - {}, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "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 removed", - "name": "removed", - "type": "date" - }, - { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" - }, - { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" } ] }, @@ -38715,28 +38715,28 @@ } ], "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": "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" - } + {} ] }, { @@ -38755,8 +38755,8 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Volume iSCSI Name", + "name": "volumeiScsiName", "type": "string" }, { @@ -38766,8 +38766,8 @@ }, {}, { - "description": "Volume iSCSI Name", - "name": "volumeiScsiName", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} @@ -38779,21 +38779,28 @@ "name": "updateAutoScaleVmGroup", "params": [ { - "description": "the ID of the autoscale group", + "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": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": true, - "type": "uuid" + "name": "minmembers", + "required": false, + "type": "integer" }, { - "description": "list of scaleup autoscale policies", + "description": "list of scaledown autoscale policies", "length": 255, - "name": "scaleuppolicyids", + "name": "scaledownpolicyids", "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, "type": "list" }, + { + "description": "the ID of the autoscale group", + "length": 255, + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "required": true, + "type": "uuid" + }, { "description": "an optional field, whether to the display the group to the end user or not", "length": 255, @@ -38803,20 +38810,19 @@ "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "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": "customid", + "name": "maxmembers", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" }, { - "description": "list of scaledown autoscale policies", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "name", "required": false, - "type": "list" + "since": "4.18.0", + "type": "string" }, { "description": "the frequency in which the performance counters to be collected", @@ -38826,25 +38832,19 @@ "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.", - "length": 255, - "name": "minmembers", - "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.", + "description": "list of scaleup autoscale policies", "length": 255, - "name": "maxmembers", + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the name of the autoscale vmgroup", + "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", + "name": "customid", "required": false, - "since": "4.18.0", + "since": "4.4", "type": "string" } ], @@ -38856,45 +38856,29 @@ "type": "boolean" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, - { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - }, - {}, { "description": "the lb provider of the guest network the lb rule belongs to", "name": "lbprovider", "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { "description": "the current state of the AutoScale Vm Group", @@ -38902,18 +38886,13 @@ "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the public port", + "name": "publicport", "type": "string" }, { @@ -38922,9 +38901,9 @@ "type": "date" }, { - "description": "the project name of the vm group", - "name": "project", - "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 public ip address id", @@ -38932,70 +38911,91 @@ "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "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 name of the autoscale vm group ", - "name": "name", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the public port", - "name": "publicport", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", "type": "int" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the name of the autoscale vm group ", + "name": "name", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "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 id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the vm group", + "name": "domainid", + "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 project id of the vm group", "name": "projectid", "type": "string" + }, + { + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", + "type": "string" + }, + {}, + { + "description": "the domain name of the vm group", + "name": "domain", + "type": "string" } ] }, @@ -39004,6 +39004,14 @@ "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 ID of the zone for the snapshot", "length": 255, @@ -39012,18 +39020,9 @@ "required": false, "since": "4.19.0", "type": "uuid" - }, - { - "description": "The ID of the snapshot", - "length": 255, - "name": "id", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", - "required": true, - "type": "uuid" } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -39034,16 +39033,17 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -39053,40 +39053,40 @@ "name": "listVirtualMachines", "params": [ { - "description": "the ID of the virtual machine", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "flag to display the resource icon for VMs", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "showicon", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list vms by template", "length": 255, - "name": "tags", + "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": "map" + "type": "uuid" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "the host ID", "length": 255, - "name": "haenable", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": false, - "since": "4.15", - "type": "boolean" + "type": "uuid" }, { - "description": "list vms by ssh keypair name", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keypair", + "name": "account", "required": false, "type": "string" }, @@ -39100,181 +39100,175 @@ "type": "uuid" }, { - "description": "list vms by iso", - "length": 255, - "name": "isoid", - "required": false, - "type": "uuid" - }, - { - "description": "list vms by template", + "description": "list by network id", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "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.", + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "details", + "name": "userdata", "required": false, - "type": "list" + "since": "4.18.0.0", + "type": "boolean" }, { - "description": "list by network id", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "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": "keyword", + "name": "details", "required": false, - "type": "string" + "type": "list" }, { - "description": "the ID of AutoScaling VM Group", + "description": "the pod ID", "length": 255, - "name": "autoscalevmgroupid", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "since": "4.18.0", "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the group ID", "length": 255, - "name": "account", + "name": "groupid", + "related": "createInstanceGroup,updateInstanceGroup", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "the cluster ID", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, + "since": "4.16.0", "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "displayvm", + "name": "haenable", "required": false, - "since": "4.4", + "since": "4.15", "type": "boolean" }, { - "description": "list by the service offering", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.4", - "type": "uuid" + "type": "boolean" }, { - "description": "the cluster 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": "clusterid", - "related": "addCluster,updateCluster", + "name": "listall", "required": false, - "since": "4.16.0", - "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": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "listall", + "name": "forvirtualnetwork", "required": false, "type": "boolean" }, { - "description": "", + "description": "the availability zone ID", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "list vms by vpc", "length": 255, - "name": "forvirtualnetwork", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", + "description": "the ID of the virtual machine", "length": 255, - "name": "isvnf", + "name": "id", + "related": "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.19.0", - "type": "boolean" + "type": "uuid" }, { - "description": "list by the backup offering", + "description": "the target hypervisor for the template", "length": 255, - "name": "backupofferingid", + "name": "hypervisor", "required": false, - "since": "4.17", - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "pagesize", + "name": "displayvm", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "list vms by vpc", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "showicon", "required": false, - "type": "uuid" + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "the pod ID", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "required": false, + "since": "4.18.0", "type": "uuid" }, { - "description": "the group ID", + "description": "list vms by iso", "length": 255, - "name": "groupid", - "related": "createInstanceGroup,updateInstanceGroup", + "name": "isoid", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the host ID", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "name": "ids", + "related": "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" + "since": "4.4", + "type": "list" }, { "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", @@ -39284,90 +39278,121 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "accumulate", "required": false, - "type": "uuid" + "since": "4.17.0", + "type": "boolean" }, { - "description": "the availability zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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,moveDomain", "required": false, "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "list by the backup offering", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "backupofferingid", "required": false, - "type": "boolean" + "since": "4.17", + "type": "uuid" }, { - "description": "the target hypervisor for the template", + "description": "list vms by ssh keypair name", "length": 255, - "name": "hypervisor", + "name": "keypair", "required": false, "type": "string" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "list vms by affinity group", "length": 255, - "name": "ids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "since": "4.4", - "type": "list" + "type": "uuid" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "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": "userdata", + "name": "isvnf", "required": false, - "since": "4.18.0.0", + "since": "4.19.0", "type": "boolean" }, { - "description": "list vms by affinity group", + "description": "list by the service offering", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "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": "List resources by tags (key/value pairs)", "length": 255, - "name": "accumulate", + "name": "tags", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "map" + }, + { + "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" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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 ID of the host for the virtual machine", - "name": "hostid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -39375,237 +39400,212 @@ "name": "templatename", "type": "string" }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, { "description": "the name of the service offering of the virtual machine", "name": "serviceofferingname", "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 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 ISO attached to the virtual machine", - "name": "isoname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "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", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "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 created", - "name": "created", - "type": "date" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, + {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "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 VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", - "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", + "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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": "the type of the nic", - "name": "type", - "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": "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 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": "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" } ], "type": "set" }, + { + "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 group name of the virtual machine", + "name": "group", + "type": "string" + }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "name": "publicipid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { @@ -39614,69 +39614,74 @@ "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "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 virtual machine", + "name": "state", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { "description": "the ID of the virtual machine", @@ -39684,194 +39689,392 @@ "type": "string" }, { - "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": "publicip", + "type": "string" }, - {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "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": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, { "description": "the incoming network traffic on the VM in KiB", "name": "networkkbsread", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "User VM type", + "name": "vmtype", "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": "User VM type", - "name": "vmtype", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "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 account associated with the tag", - "name": "account", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 domain associated with the tag", - "name": "domainid", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", + "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": "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": "the gateway of the nic", + "name": "gateway", + "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "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 ID of the host for the virtual machine", + "name": "hostid", + "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 list of resource tags associated", + "name": "tags", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account owning the security group", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "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" + } + ], + "type": "set" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "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 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": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "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": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -39880,32 +40083,42 @@ "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", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -39914,13 +40127,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -39929,8 +40142,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -39939,40 +40152,65 @@ "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": "tag value", + "name": "value", + "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 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 list of egress rules associated with the security group", - "name": "egressrule", + "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 id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of 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", @@ -39983,28 +40221,23 @@ "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 key name", - "name": "key", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -40013,58 +40246,48 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "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 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": "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 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": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "security group name", "name": "securitygroupname", @@ -40075,26 +40298,56 @@ "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 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 account owning the security group", + "name": "account", + "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 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 ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -40108,187 +40361,89 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the description of the security group", + "name": "description", "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" } ], "type": "set" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "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": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "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": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "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 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 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 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 account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "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 vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -40296,188 +40451,143 @@ "name": "backupofferingname", "type": "string" }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "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": "Lists all available disk offerings.", + "isasync": false, + "name": "listDiskOfferings", + "params": [ { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "listed offerings support disk encryption", + "length": 255, + "name": "encrypt", + "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "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": "the storage type of the service offering. Values are local and shared.", + "length": 255, + "name": "storagetype", + "required": false, + "since": "4.19", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "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": "virtualmachineid", + "related": "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": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "ID of the disk offering", + "length": 255, + "name": "id", + "related": "createDiskOffering,listDiskOfferings", + "required": false, + "type": "uuid" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "The ID of the volume, tags of the volume are used to filter the offerings", + "length": 255, + "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" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "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 state of the virtual machine", - "name": "state", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "name of the disk offering", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "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": " 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", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - } - ] - }, - { - "description": "Lists all available disk offerings.", - "isasync": false, - "name": "listDiskOfferings", - "params": [ - { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", "length": 255, - "name": "storagetype", + "name": "state", "required": false, "since": "4.19", "type": "string" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -40485,321 +40595,211 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" - }, + } + ], + "related": "createDiskOffering", + "response": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "state of the disk offering", + "name": "state", + "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 (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "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": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": false, - "since": "4.20.0", - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" }, { - "description": "listed offerings support disk encryption", - "length": 255, + "description": "Whether disks using this offering will be encrypted on primary storage", "name": "encrypt", - "required": false, - "since": "4.18", "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 ID of the volume, tags of the volume are used to filter the offerings", - "length": 255, - "name": "volumeid", - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", - "length": 255, - "name": "state", - "required": false, - "since": "4.19", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "name of the disk offering", - "length": 255, - "name": "name", - "required": false, - "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": "ID of the disk offering", - "length": 255, + "description": "unique ID of the disk offering", "name": "id", - "related": "createDiskOffering,listDiskOfferings", - "required": false, - "type": "uuid" + "type": "string" }, { - "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" - } - ], - "related": "createDiskOffering", - "response": [ + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" + }, { "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 min iops of the disk offering", "name": "miniops", "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "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": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "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": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "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": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "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 storage type for this disk offering", + "name": "storagetype", + "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "state of the disk offering", - "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": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" - }, { "description": "the size of the disk offering in GB", "name": "disksize", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, - { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "the storage type for this disk offering", - "name": "storagetype", - "type": "string" - }, + {}, { "description": "bytes read rate of the disk offering", "name": "diskBytesReadRate", "type": "long" }, - { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" - }, - { - "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": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" - }, - { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "the name of the disk offering", - "name": "name", - "type": "string" - }, - { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" - }, { "description": "the max iops of the disk offering", "name": "maxiops", "type": "long" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" - }, - { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" - }, - { - "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": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "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": "unique ID of the disk offering", - "name": "id", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" } ] }, @@ -40818,7 +40818,6 @@ } ], "response": [ - {}, {}, { "description": "any text associated with the success or failure", @@ -40835,6 +40834,7 @@ "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -40848,18 +40848,18 @@ "name": "upgradeKubernetesCluster", "params": [ { - "description": "the ID of the Kubernetes version for upgrade", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "kubernetesversionid", - "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "required": true, "type": "uuid" }, { - "description": "the ID of the Kubernetes cluster", + "description": "the ID of the Kubernetes version for upgrade", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "name": "kubernetesversionid", + "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, "type": "uuid" } @@ -40872,43 +40872,54 @@ "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, + {}, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", "type": "long" }, { @@ -40917,9 +40928,14 @@ "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 size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { "description": "Whether autoscaling is enabled for the cluster", @@ -40927,137 +40943,121 @@ "type": "boolean" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "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 Kubernetes cluster exists", - "name": "domainid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, - {}, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" - }, - { - "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": "keypair details", - "name": "keypair", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" - }, - { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, - {}, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" - } + }, + {} ] }, { @@ -41081,13 +41081,6 @@ "required": false, "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" - }, { "description": "the account of the condition. Must be used with the domainId parameter.", "length": 255, @@ -41109,6 +41102,13 @@ "name": "threshold", "required": true, "type": "long" + }, + { + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "length": 255, + "name": "relationaloperator", + "required": true, + "type": "string" } ], "related": "listConditions", @@ -41119,19 +41119,19 @@ "type": "long" }, { - "description": "the owner of the Condition.", - "name": "account", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { - "description": "the Name of the Counter.", - "name": "countername", + "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 domain id of the Condition owner", + "name": "domainid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -41139,54 +41139,54 @@ "type": "integer" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, { - "description": "the Id of the Counter.", - "name": "counterid", + "description": "the Name of the Counter.", + "name": "countername", "type": "string" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", "type": "string" }, { - "description": "the id of the Condition", - "name": "id", - "type": "string" + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" }, - {}, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { - "description": "path of the domain to which the Condition owner belongs", - "name": "domainpath", + "description": "the owner of the Condition.", + "name": "account", "type": "string" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "the Id of the Counter.", + "name": "counterid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the Condition", + "name": "project", "type": "string" }, + {}, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the id of the Condition", + "name": "id", "type": "string" }, {} @@ -41198,33 +41198,19 @@ "name": "listProjects", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list projects by name", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "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": "List projects by username", "length": 255, @@ -41232,13 +41218,6 @@ "required": false, "type": "string" }, - { - "description": "list projects by state", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -41247,13 +41226,6 @@ "required": false, "type": "uuid" }, - { - "description": "list projects by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "list projects by project ID", "length": 255, @@ -41263,23 +41235,23 @@ "type": "uuid" }, { - "description": "flag to display the resource icon for projects", + "description": "List projects by tags (key/value pairs)", "length": 255, - "name": "showicon", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list projects by display text", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "displaytext", + "name": "account", "required": false, "type": "string" }, @@ -41291,45 +41263,123 @@ "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": "integer" + }, + { + "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": "flag to display the resource icon for projects", + "length": 255, + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "List projects by tags (key/value pairs)", + "description": "list projects by state", "length": 255, - "name": "tags", + "name": "state", "required": false, - "type": "map" + "type": "string" + }, + { + "description": "list projects by display text", + "length": 255, + "name": "displaytext", + "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" } ], "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "response": [ { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the name of the project", + "name": "name", "type": "string" }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, { "description": "the displaytext of the project", "name": "displaytext", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "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" }, { @@ -41338,14 +41388,19 @@ "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "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", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { "description": "the date this project was created", @@ -41353,8 +41408,28 @@ "type": "date" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "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 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 snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { @@ -41363,110 +41438,146 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "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 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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, - { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" - }, + {}, { "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 total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "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", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { @@ -41475,156 +41586,59 @@ "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "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", + "type": "string" }, + {}, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Creates an account", + "isasync": false, + "name": "createAccount", + "params": [ { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "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": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "lastname", + "length": 255, + "name": "lastname", + "required": true, + "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", - "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 available to be created for this project", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" - }, - {}, - { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "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": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the id of the project", - "name": "id", - "type": "string" - }, - {} - ], - "since": "3.0.0" - }, - { - "description": "Creates an account", - "isasync": false, - "name": "createAccount", - "params": [ - { - "description": "Unique username.", + "description": "details for account used to store specific parameters", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "accountdetails", + "required": false, + "type": "map" }, { "description": "firstname", @@ -41641,40 +41655,26 @@ "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, - "type": "string" - }, - { - "description": "Account UUID, required for adding account from external provisioning system", + "description": "Network domain for the account's networks", "length": 255, - "name": "accountid", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "Creates the user under the specified domain.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "timezone", "required": false, - "type": "uuid" - }, - { - "description": "lastname", - "length": 255, - "name": "lastname", - "required": true, "type": "string" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "Creates the account under the specified role.", "length": 255, - "name": "accounttype", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "User UUID, required for adding account from external provisioning system", @@ -41684,249 +41684,227 @@ "type": "string" }, { - "description": "details for account used to store specific parameters", + "description": "Account UUID, required for adding account from external provisioning system", "length": 255, - "name": "accountdetails", + "name": "accountid", "required": false, - "type": "map" + "type": "string" }, { - "description": "email", + "description": "Unique username.", "length": 255, - "name": "email", + "name": "username", "required": true, "type": "string" }, { - "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,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "email", "length": 255, - "name": "timezone", - "required": false, + "name": "email", + "required": true, "type": "string" }, { - "description": "Creates the account under the specified role.", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "accounttype", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ { - "description": "the id of the account", - "name": "id", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "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 owned by account", - "name": "cputotal", - "type": "long" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, - {}, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, - {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "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 available for this account to acquire", - "name": "vmavailable", + "description": "the id of the account", + "name": "id", "type": "string" }, - { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, { "description": "the name of the account", "name": "name", "type": "string" }, { - "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 name of the role", - "name": "rolename", - "type": "string" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the user firstname", - "name": "firstname", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the user state", + "name": "state", + "type": "string" }, { - "description": "the user email address", - "name": "email", + "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": "the user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "true if user has two factor authentication enabled", "name": "is2faenabled", "type": "boolean" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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 lastname", - "name": "lastname", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" }, { "description": "the secret key of the user", @@ -41937,84 +41915,86 @@ "type": "list" }, { - "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": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "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 templates which can be created by this account", - "name": "templatelimit", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, + {}, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "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 projects the account can own", - "name": "projectlimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { "description": "the total secondary storage space (in GiB) available to be used for this account", @@ -42022,58 +42002,83 @@ "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", "type": "integer" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "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 the account can own", - "name": "vpclimit", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { @@ -42082,79 +42087,74 @@ "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "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", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "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 number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" } ] }, @@ -42172,185 +42172,120 @@ "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "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 account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, { "description": "the memory allocated for the virtual machine", "name": "memory", "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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 received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "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 virtual machine", - "name": "id", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "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 amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "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 backup offering of the virtual machine", "name": "backupofferingname", "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 group ID of the virtual machine", - "name": "groupid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "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 domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -42359,13 +42294,13 @@ "type": "string" }, { - "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" }, { @@ -42374,18 +42309,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "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": "tag key name", + "name": "key", "type": "string" }, { @@ -42394,230 +42324,63 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, - {}, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, { "description": "the state of the virtual machine", "name": "state", "type": "string" }, { - "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": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - {}, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "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 account owning the security group", "name": "account", "type": "string" }, { - "description": "the description of the security group", - "name": "description", - "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 name of the security group", - "name": "name", - "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 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": "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": "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": "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 value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -42626,13 +42389,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -42641,13 +42404,18 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -42657,110 +42425,6 @@ } ], "type": "set" - } - ], - "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 project name of the group", - "name": "project", - "type": "string" - }, - { - "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 egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "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": "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": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "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 ending IP of the security group rule ", @@ -42768,20 +42432,25 @@ "type": "integer" }, { - "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": "security group name", - "name": "securitygroupname", - "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 protocol of the security group rule", "name": "protocol", @@ -42793,50 +42462,65 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "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 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", + "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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 name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -42845,97 +42529,169 @@ "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": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "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": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" }, { - "description": "the name of the affinity group", + "description": "the name of the security group", "name": "name", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "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 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 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": "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": "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" + } + ], + "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": "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "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", + "description": "the description of the security group", + "name": "description", "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 list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the project ID of the affinity group", + "description": "the project id of the group", "name": "projectid", "type": "string" } @@ -42943,80 +42699,55 @@ "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 ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "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 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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { "description": "the name of the ISO attached to the virtual machine", @@ -43024,122 +42755,112 @@ "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "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": "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 id of userdata used for the VM", - "name": "userdataid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "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 write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "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": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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 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 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 netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -43148,68 +42869,83 @@ "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": "the ID of the corresponding network", - "name": "networkid", + "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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": "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "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", + "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "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" }, { @@ -43217,6 +42953,21 @@ "name": "gateway", "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 corresponding network", + "name": "networkid", + "type": "string" + }, { "description": "the gateway of IPv6 network", "name": "ip6gateway", @@ -43226,44 +42977,293 @@ "description": "Id of the vpc to which the nic belongs", "name": "vpcid", "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "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", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "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": "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "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 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 entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "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 nic", - "name": "id", + "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 netmask of the nic", - "name": "netmask", + "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 ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the project name of the affinity group", + "name": "project", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the type of the affinity group", + "name": "type", + "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 password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "User VM type", + "name": "vmtype", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "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": "the group name of the virtual machine", + "name": "group", + "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": "device type of the root volume", + "name": "rootdevicetype", + "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", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" } ], "since": "4.2.0" @@ -43283,11 +43283,6 @@ } ], "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", @@ -43299,12 +43294,17 @@ "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "4.4.0" }, @@ -43314,11 +43314,11 @@ "name": "createTungstenFabricServiceGroup", "params": [ { - "description": "Tungsten-Fabric service group start port", + "description": "Tungsten-Fabric service group name", "length": 255, - "name": "startport", + "name": "name", "required": true, - "type": "integer" + "type": "string" }, { "description": "Tungsten-Fabric service group protocol", @@ -43328,11 +43328,11 @@ "type": "string" }, { - "description": "Tungsten-Fabric service group name", + "description": "Tungsten-Fabric service group start port", "length": 255, - "name": "name", + "name": "startport", "required": true, - "type": "string" + "type": "integer" }, { "description": "the ID of zone", @@ -43352,17 +43352,6 @@ ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric service group uuid", - "name": "uuid", - "type": "string" - }, { "description": "Tungsten-Fabric service group protocol", "name": "protocol", @@ -43373,19 +43362,30 @@ "name": "name", "type": "string" }, + { + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "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 service group start port", - "name": "startport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric service group end port", + "name": "endport", "type": "int" }, { @@ -43395,8 +43395,8 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", "type": "string" } ] @@ -43417,9 +43417,9 @@ ], "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" }, {}, { @@ -43427,17 +43427,17 @@ "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.20.0" }, @@ -43447,35 +43447,25 @@ "name": "registerIso", "params": [ { - "description": "the ID of the zone you wish to register the ISO to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "description": "the URL to where the ISO is currently being hosted", + "length": 2048, + "name": "url", "required": true, - "type": "uuid" - }, - { - "description": "an optional domainId. 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" + "type": "string" }, { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "isdynamicallyscalable", + "name": "directdownload", "required": false, "type": "boolean" }, { - "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", + "description": "an optional account name. Must be used with domainId.", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Register ISO for the project", @@ -43485,6 +43475,14 @@ "required": false, "type": "uuid" }, + { + "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": "true if the ISO or its derivatives are extractable; default is false", "length": 255, @@ -43493,25 +43491,33 @@ "type": "boolean" }, { - "description": "the name of the ISO", + "description": "true if password reset feature is supported; default is false", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "an optional account name. Must be used with domainId.", - "length": 255, - "name": "account", + "description": "the display text of the ISO, defaults to the 'name'", + "length": 4096, + "name": "displaytext", "required": false, "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.", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "checksum", + "name": "bootable", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "an optional domainId. 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": "true if you want this ISO to be featured", @@ -43521,40 +43527,41 @@ "type": "boolean" }, { - "description": "true if password reset feature is supported; default is false", + "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": "passwordenabled", + "name": "checksum", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "arch", + "name": "ispublic", "required": false, - "since": "4.20", - "type": "string" + "type": "boolean" }, { - "description": "the display text of the ISO, defaults to the 'name'", - "length": 4096, - "name": "displaytext", + "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": "addGuestOs", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the URL to where the ISO is currently being hosted", - "length": 2048, - "name": "url", + "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": "string" + "type": "uuid" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "the name of the ISO", "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { "description": "Image store UUID", @@ -43564,218 +43571,141 @@ "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 you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", "length": 255, - "name": "ispublic", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ - { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "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 ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the size of the template", - "name": "size", - "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": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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 project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the template", + "name": "project", + "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": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", + "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": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, - {}, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "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": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "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": "the name of the zone for this template", - "name": "zonename", + "description": "the template name", + "name": "name", "type": "string" }, { @@ -43783,66 +43713,116 @@ "name": "sourcetemplateid", "type": "string" }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, {}, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "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": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "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": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" }, { "description": "true if the ISO is bootable, false otherwise", @@ -43850,18 +43830,18 @@ "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { @@ -43870,28 +43850,38 @@ "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the template display text", - "name": "displaytext", + "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", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -43899,6 +43889,21 @@ "name": "userdataid", "type": "string" }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", @@ -43910,14 +43915,9 @@ "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" } ] }, @@ -43926,20 +43926,27 @@ "isasync": false, "name": "listCiscoAsa1000vResources", "params": [ + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "Cisco ASA 1000v resource ID", @@ -43956,13 +43963,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", "length": 255, @@ -43973,7 +43973,6 @@ ], "related": "addCiscoAsa1000vResource", "response": [ - {}, {}, {}, { @@ -43983,12 +43982,13 @@ }, {}, {}, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, {} ] }, @@ -44007,14 +44007,15 @@ } ], "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -44024,11 +44025,10 @@ }, {}, { - "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" - }, - {} + } ] }, { @@ -44051,14 +44051,6 @@ "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 router with the specified Id", "length": 255, @@ -44075,6 +44067,14 @@ "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 within the specified pod", "length": 255, @@ -44086,6 +44086,8 @@ ], "related": "", "response": [ + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -44095,359 +44097,355 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - {} + } ] }, { - "description": "Lists IPv4 subnets for guest networks.", - "isasync": false, - "name": "listIpv4SubnetsForGuestNetwork", + "description": "Cancels host maintenance.", + "isasync": true, + "name": "cancelHostMaintenance", "params": [ { - "description": "UUID of the IPv4 subnet for guest network.", + "description": "the host ID", "length": 255, "name": "id", - "related": "createIpv4SubnetForGuestNetwork,listIpv4SubnetsForGuestNetwork", - "required": false, + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": true, "type": "uuid" - }, - { - "description": "The CIDR of the Ipv4 subnet.", - "length": 255, - "name": "subnet", - "required": false, - "type": "string" - }, + } + ], + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "response": [ { - "description": "UUID of network to which the IPv4 subnet is associated to.", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "UUID of VPC to which the IPv4 subnet is associated to.", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "UUID of zone to which the IPv4 subnet belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", - "length": 255, - "name": "parentid", - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", - "required": false, - "type": "uuid" + "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" - } - ], - "related": "createIpv4SubnetForGuestNetwork", - "response": [ - { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" + "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": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "id of network which the IPv4 subnet is associated with.", - "name": "networkid", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "date when this IPv4 subnet was allocated.", - "name": "allocated", - "type": "date" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "date when this IPv4 subnet was removed.", - "name": "removed", - "type": "date" + "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": "CPU Arch of the host", + "name": "arch", "type": "string" }, + {}, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zonename", - "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": "id of the data center IPv4 subnet", - "name": "parentid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "id of the IPv4 subnet for guest network", - "name": "id", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, - {}, { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "state of subnet of the IPv4 network", - "name": "state", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the VPC which the IPv4 subnet is associated with.", - "name": "vpcid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, - {}, { - "description": "subnet of the IPv4 network", - "name": "subnet", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "subnet of the data center IPv4 subnet", - "name": "parentsubnet", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "Name of the VPC which the IPv4 subnet is associated with.", - "name": "vpcname", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, + {}, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Cancels host maintenance.", - "isasync": true, - "name": "cancelHostMaintenance", - "params": [ - { - "description": "the host ID", - "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", - "response": [ + "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "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 Zone name of the host", "name": "zonename", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the name of the host", - "name": "name", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "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 MHz", - "name": "cpuallocatedvalue", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum displays per user", + "name": "maxheads", + "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" + }, + { + "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": "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" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", + "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": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, - {}, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "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 host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { "description": "true if the host supports encryption", @@ -44460,228 +44458,106 @@ "type": "boolean" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the management server ID of the host", + "name": "managementserverid", "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 after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "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", + "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { "description": "the host version", "name": "version", "type": "string" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, + } + ] + }, + { + "description": "Lists all VLAN IP ranges.", + "isasync": false, + "name": "listVlanIpRanges", + "params": [ { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the ID of the VLAN IP range", + "length": 255, + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "required": false, + "type": "uuid" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "length": 255, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "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" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "type": "string" + "description": "the Zone ID of the VLAN IP range", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "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 Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "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" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" - }, - { - "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": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" - } - ] - }, - { - "description": "Lists all VLAN IP ranges.", - "isasync": false, - "name": "listVlanIpRanges", - "params": [ - { - "description": "the Zone ID of the VLAN IP range", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "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": "the Pod ID of the VLAN IP range", @@ -44692,42 +44568,13 @@ "type": "uuid" }, { - "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" - }, - { - "description": "project who will own the VLAN", + "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": "projectid", - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "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": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", - "length": 255, - "name": "vlan", - "required": false, - "type": "string" - }, { "description": "true if VLAN is of Virtual type, false if Direct", "length": 255, @@ -44736,18 +44583,10 @@ "type": "boolean" }, { - "description": "the ID of the VLAN IP range", - "length": 255, - "name": "id", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", - "required": false, - "type": "uuid" - }, - { - "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": "project who will own the VLAN", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -44767,34 +44606,40 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", "response": [ + { + "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 cidr of the VLAN IP range", - "name": "cidr", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, + {}, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the domain ID of the VLAN IP range", + "name": "domainid", + "type": "string" }, { "description": "the project name of the vlan range", @@ -44802,100 +44647,94 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", - "type": "boolean" - }, - { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "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", + "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", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, {}, - {}, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" - }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", - "type": "string" + "description": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", + "type": "boolean" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "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", + "name": "id", "type": "string" }, { @@ -44904,19 +44743,19 @@ "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", - "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", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" } ] }, @@ -44933,115 +44772,115 @@ "type": "boolean" }, { - "description": "the guest CIDR address for the Zone", + "description": "the second DNS for the Zone", "length": 255, - "name": "guestcidraddress", + "name": "dns2", "required": false, "type": "string" }, { - "description": "the first DNS for the Zone", + "description": "the details for the Zone", "length": 255, - "name": "dns1", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "the dns search order list", + "description": "the ID of the Zone", "length": 255, - "name": "dnssearchorder", - "required": false, - "type": "list" + "name": "id", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the first internal DNS for the Zone", + "description": "the name of the Zone", "length": 255, - "name": "internaldns1", + "name": "name", "required": false, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the dhcp Provider for the Zone", "length": 255, - "name": "allocationstate", + "name": "dhcpprovider", "required": false, "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "sort key of the zone, integer", "length": 255, - "name": "ip6dns2", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the second internal DNS for the Zone", + "description": "the first DNS for the Zone", "length": 255, - "name": "internaldns2", + "name": "dns1", "required": false, "type": "string" }, { - "description": "the second DNS for the Zone", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "dns2", + "name": "guestcidraddress", "required": false, "type": "string" }, { - "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", + "description": "the dns search order list", "length": 255, - "name": "domain", + "name": "dnssearchorder", "required": false, - "type": "string" + "type": "list" }, { - "description": "sort key of the zone, integer", + "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", "length": 255, - "name": "sortkey", + "name": "domain", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the name of the Zone", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "name", + "name": "ip6dns1", "required": false, "type": "string" }, { - "description": "the ID of the Zone", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "ip6dns2", + "required": false, + "type": "string" }, { - "description": "the dhcp Provider for the Zone", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "dhcpprovider", + "name": "localstorageenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the details for the Zone", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "details", + "name": "internaldns1", "required": false, - "type": "map" + "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "localstorageenabled", + "name": "allocationstate", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "ip6dns1", + "name": "internaldns2", "required": false, "type": "string" } @@ -45049,39 +44888,8 @@ "related": "createZone,listZones,listZones", "response": [ { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" - }, - { - "description": "Zone id", - "name": "id", - "type": "string" - }, - { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" - }, - {}, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" - }, - { - "description": "Zone name", - "name": "name", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { @@ -45090,18 +44898,8 @@ "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" - }, - { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { @@ -45109,8 +44907,13 @@ "name": "capacity", "response": [ { - "description": "the Zone name", - "name": "zonename", + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -45118,6 +44921,11 @@ "name": "capacityallocated", "type": "long" }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, { "description": "the Pod name", "name": "podname", @@ -45128,16 +44936,6 @@ "name": "podid", "type": "string" }, - { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, { "description": "the total capacity available", "name": "capacitytotal", @@ -45149,41 +44947,46 @@ "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", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Zone name", + "name": "zonename", + "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the capacity name", - "name": "name", + "description": "the Cluster name", + "name": "clustername", "type": "string" } ], "type": "list" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { @@ -45192,8 +44995,18 @@ "type": "boolean" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", "type": "integer" }, { @@ -45202,147 +45015,173 @@ "type": "boolean" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "Zone name", + "name": "name", + "type": "string" + }, + { + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + }, + {}, + { + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" + }, + {}, + { + "description": "Zone id", + "name": "id", + "type": "string" + }, + { + "description": "Zone description", + "name": "description", + "type": "string" + }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" }, { "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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": "the ID of the domain associated with the tag", - "name": "domainid", + "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 project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "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" + "description": "AS Number Range", + "name": "asnrange", + "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "Zone description", - "name": "description", - "type": "string" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "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": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" } ] }, @@ -45359,6 +45198,13 @@ "required": true, "type": "uuid" }, + { + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, + "type": "string" + }, { "description": "the url to which the volume would be extracted", "length": 2048, @@ -45370,20 +45216,24 @@ "description": "the ID of the volume", "length": 255, "name": "id", - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "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": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, - "type": "string" } ], - "related": "downloadImageStoreObject,extractIso,extractSnapshot,extractTemplate", + "related": "extractIso,extractSnapshot,extractTemplate,downloadImageStoreObject", "response": [ + { + "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": "the upload id of extracted object", "name": "extractId", @@ -45394,34 +45244,19 @@ "name": "zonename", "type": "string" }, - { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, { "description": "the percentage of the entity uploaded to the specified location", "name": "uploadpercentage", "type": "integer" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", - "type": "string" - }, - { - "description": "the status of the extraction", - "name": "status", - "type": "string" - }, - { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { @@ -45430,30 +45265,28 @@ "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "the name of the extracted object", + "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 state of the extracted object", "name": "state", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account id to which the extracted object belongs", + "name": "accountid", + "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 status of the extraction", + "name": "status", "type": "string" }, { @@ -45465,126 +45298,43 @@ "description": "zone ID the object was extracted from", "name": "zoneid", "type": "string" - } - ] - }, - { - "description": "Releases an existing dedicated IPv4 subnet for a zone.", - "isasync": true, - "name": "releaseIpv4SubnetForZone", - "params": [ - { - "description": "Id of the guest network IPv4 subnet", - "length": 255, - "name": "id", - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", - "required": true, - "type": "uuid" - } - ], - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "response": [ - { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain name of the IPv4 subnet", - "name": "domain", - "type": "string" - }, - { - "description": "guest IPv4 subnet", - "name": "subnet", - "type": "string" - }, - { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" - }, - { - "description": "the project id of the IPv4 subnet", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the IPv4 subnet", - "name": "project", - "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 domain ID of the IPv4 subnet", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the guest IPv4 subnet", - "name": "id", - "type": "string" - }, - { - "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" } - ], - "since": "4.20.0" + ] }, { - "description": "Lists project's accounts", + "description": "Lists IPv4 subnets for guest networks.", "isasync": false, - "name": "listProjectAccounts", + "name": "listIpv4SubnetsForGuestNetwork", "params": [ { - "description": "list accounts of the project by account name", + "description": "The CIDR of the Ipv4 subnet.", "length": 255, - "name": "account", + "name": "subnet", "required": false, "type": "string" }, { - "description": "list invitation by user ID", + "description": "UUID of the IPv4 subnet for guest network.", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "id", + "related": "createIpv4SubnetForGuestNetwork,listIpv4SubnetsForGuestNetwork", "required": false, "type": "uuid" }, { - "description": "list accounts of the project by project role id", + "description": "UUID of network to which the IPv4 subnet is associated to.", "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, - { - "description": "ID of the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -45600,11 +45350,20 @@ "type": "integer" }, { - "description": "list accounts of the project by role", + "description": "UUID of zone to which the IPv4 subnet belongs to.", "length": 255, - "name": "role", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "UUID of VPC to which the IPv4 subnet is associated to.", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { "description": "", @@ -45612,18 +45371,32 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", + "length": 255, + "name": "parentid", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "required": false, + "type": "uuid" } ], - "related": "activateProject,createProject,suspendProject,updateProject", + "related": "createIpv4SubnetForGuestNetwork", "response": [ { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "id of the IPv4 subnet for guest network", + "name": "id", + "type": "string" + }, + {}, + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { @@ -45632,24 +45405,29 @@ "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", "type": "string" }, - {}, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" }, { @@ -45658,141 +45436,110 @@ "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "id of the data center IPv4 subnet", + "name": "parentid", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "Lists project's accounts", + "isasync": false, + "name": "listProjectAccounts", + "params": [ { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" + "description": "ID of the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the state of the project", - "name": "state", - "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": "list invitation by user ID", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "list accounts of the project by project role id", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "list accounts of the project by role", + "length": 255, + "name": "role", + "required": false, "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "list accounts of the project by account name", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, - { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, + } + ], + "related": "activateProject,createProject,suspendProject,updateProject", + "response": [ { "description": "the total number of public ip addresses this project can acquire", "name": "iplimit", "type": "string" }, - { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" - }, - {}, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, { "description": "the total number of virtual machines running for this project", "name": "vmrunning", @@ -45803,33 +45550,14 @@ "name": "memorytotal", "type": "long" }, - { - "description": "the name of the project", - "name": "name", - "type": "string" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, + {}, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -45837,34 +45565,24 @@ "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": "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", + "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" }, { @@ -45877,32 +45595,58 @@ "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" } ], "type": "list" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "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 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", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "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 total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { @@ -45911,94 +45655,143 @@ "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - } - ], - "since": "3.0.0" - }, - { - "description": "Updates an existing autoscale policy.", - "isasync": true, - "name": "updateAutoScalePolicy", - "params": [ + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { - "description": "the ID of the autoscale policy", - "length": 255, - "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "uuid" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "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, + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", "type": "integer" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "length": 255, - "name": "conditionids", - "related": "listConditions", - "required": false, - "type": "list" + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "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" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the name of the autoscale policy", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" - } - ], - "related": "listAutoScalePolicies", - "response": [ - {}, + }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the domain name of the autoscale policy", + "description": "the domain name where the project belongs to", "name": "domain", "type": "string" }, - {}, { - "description": "the autoscale policy ID", + "description": "the id of the project", "name": "id", "type": "string" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the state of the project", + "name": "state", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { @@ -46007,91 +45800,104 @@ "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "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": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "name of the autoscale policy", - "name": "name", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "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 that can be deployed by this project", + "name": "vmlimit", + "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" } - ] + ], + "since": "3.0.0" }, { - "description": "Creates a IPv4 subnet for a zone.", + "description": "Releases an existing dedicated IPv4 subnet for a zone.", "isasync": true, - "name": "createIpv4SubnetForZone", + "name": "releaseIpv4SubnetForZone", "params": [ { - "description": "domain ID of the account owning the IPv4 subnet", + "description": "Id of the guest network IPv4 subnet", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, + "name": "id", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "required": true, "type": "uuid" + } + ], + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "response": [ + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "project who will own the IPv4 subnet", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" }, { - "description": "The CIDR of the IPv4 subnet.", - "length": 255, - "name": "subnet", - "required": true, + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, { - "description": "account who will own the IPv4 subnet", - "length": 255, - "name": "account", - "required": false, + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { - "description": "UUID of the zone which the IPv4 subnet belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "response": [ + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" + }, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { @@ -46104,55 +45910,138 @@ "name": "created", "type": "date" }, - {}, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "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 an existing autoscale policy.", + "isasync": true, + "name": "updateAutoScalePolicy", + "params": [ + { + "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 domain ID of the IPv4 subnet", - "name": "domainid", + "description": "the name of the autoscale policy", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the project id of the IPv4 subnet", + "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": "listConditions", + "required": false, + "type": "list" + }, + { + "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" + } + ], + "related": "listAutoScalePolicies", + "response": [ + { + "description": "the project id autoscale policy", "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, { - "description": "id of the guest IPv4 subnet", - "name": "id", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, + {}, { - "description": "the domain name of the IPv4 subnet", + "description": "the domain name of the autoscale policy", "name": "domain", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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 list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" + }, + { + "description": "the domain ID of the autoscale policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the autoscale policy", + "name": "account", + "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", + "type": "string" + }, + { + "description": "the project name of the autoscale policy", + "name": "project", + "type": "string" + }, + { + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", + "type": "string" } - ], - "since": "4.20.0" + ] }, { "description": "Creates a disk offering.", @@ -46160,19 +46049,26 @@ "name": "createDiskOffering", "params": [ { - "description": "name of the disk offering", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "bytesreadrate", + "required": false, + "type": "long" }, { - "description": "burst requests read rate of the disk offering", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "iopsreadratemax", + "name": "iopswriteratemax", "required": false, "type": "long" }, + { + "description": "name of the disk offering", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "the ID of the containing zone(s), null for public offerings", "length": 255, @@ -46183,27 +46079,19 @@ "type": "list" }, { - "description": "whether disk offering iops is custom or not", - "length": 255, - "name": "customizediops", - "required": false, - "type": "boolean" - }, - { - "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": "length (in seconds) of the burst", "length": 255, - "name": "disksizestrictness", + "name": "byteswriteratemaxlength", "required": false, - "since": "4.17", - "type": "boolean" + "type": "long" }, { - "description": "Volumes using this offering should be encrypted", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "encrypt", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.18", - "type": "boolean" + "type": "list" }, { "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", @@ -46214,13 +46102,6 @@ "since": "4.15", "type": "uuid" }, - { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "type": "long" - }, { "description": "burst bytes read rate of the disk offering", "length": 255, @@ -46229,37 +46110,38 @@ "type": "long" }, { - "description": "min iops of the disk offering", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "miniops", + "name": "displayoffering", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "whether disk offering size is custom or not", + "description": "Volumes using this offering should be encrypted", "length": 255, - "name": "customized", + "name": "encrypt", "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "byteswriteratemaxlength", + "name": "provisioningtype", "required": false, - "type": "long" + "type": "string" }, { - "description": "tags for the disk offering", - "length": 4096, - "name": "tags", + "description": "whether disk offering iops is custom or not", + "length": 255, + "name": "customizediops", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "io requests read rate of the disk offering", + "description": "max iops of the disk offering", "length": 255, - "name": "iopsreadrate", + "name": "maxiops", "required": false, "type": "long" }, @@ -46271,33 +46153,40 @@ "type": "long" }, { - "description": "bytes write rate of the disk offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "byteswriterate", + "name": "iopswriterate", "required": false, "type": "long" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "disksizestrictness", "required": false, - "type": "list" + "since": "4.17", + "type": "boolean" }, { - "description": "io requests write rate of the disk offering", + "description": "An alternate display text of the disk offering, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopswriterate", + "name": "iopsreadratemaxlength", "required": false, "type": "long" }, { - "description": "burst io requests write rate of the disk offering", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "iopswriteratemax", + "name": "hypervisorsnapshotreserve", "required": false, - "type": "long" + "type": "integer" }, { "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", @@ -46307,75 +46196,75 @@ "type": "long" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "cachemode", "required": false, - "type": "integer" + "since": "4.14", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "the storage type of the disk offering. Values are local and shared.", "length": 255, - "name": "cachemode", + "name": "storagetype", "required": false, - "since": "4.14", "type": "string" }, { - "description": "max iops of the disk offering", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "maxiops", + "name": "byteswriterate", "required": false, "type": "long" }, { - "description": "An alternate display text of the disk offering, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "description": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", "required": false, - "type": "string" + "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "whether disk offering size is custom or not", "length": 255, - "name": "iopswriteratemaxlength", + "name": "customized", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "bytes read rate of the disk offering", + "description": "min iops of the disk offering", "length": 255, - "name": "bytesreadrate", + "name": "miniops", "required": false, "type": "long" }, { "description": "length (in seconds) of the burst", "length": 255, - "name": "iopsreadratemaxlength", + "name": "iopswriteratemaxlength", "required": false, "type": "long" }, { - "description": "the storage type of the disk offering. Values are local and shared.", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "storagetype", + "name": "iopsreadratemax", "required": false, - "type": "string" + "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "provisioningtype", + "name": "bytesreadratemaxlength", "required": false, - "type": "string" + "type": "long" }, { - "description": "an optional field, whether to display the offering to the end user or not.", - "length": 255, - "name": "displayoffering", + "description": "tags for the disk offering", + "length": 4096, + "name": "tags", "required": false, - "type": "boolean" + "type": "string" }, { "description": "details to specify disk offering parameters", @@ -46389,29 +46278,34 @@ "related": "", "response": [ { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "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 cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", + "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "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", @@ -46419,55 +46313,70 @@ "type": "integer" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, + { + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", + "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 storage type for this disk offering", - "name": "storagetype", + "description": "additional key/value details tied with this disk offering", + "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": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "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 max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, {}, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "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": "the date this disk offering was created", + "name": "created", + "type": "date" }, { "description": "io requests write rate of the disk offering", @@ -46475,24 +46384,38 @@ "type": "long" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" + }, + { + "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": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { - "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", "type": "boolean" }, { @@ -46501,96 +46424,173 @@ "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "the storage type for this disk offering", + "name": "storagetype", + "type": "string" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" + }, + { + "description": "state of the disk offering", + "name": "state", "type": "string" }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" + }, + { + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, { "description": "bytes write rate of the disk offering", "name": "diskBytesWriteRate", "type": "long" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "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 domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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 name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "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 size of the disk offering in GB", "name": "disksize", "type": "long" + } + ] + }, + { + "description": "Creates a IPv4 subnet for a zone.", + "isasync": true, + "name": "createIpv4SubnetForZone", + "params": [ + { + "description": "The CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": true, + "type": "string" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "domain ID of the account owning the IPv4 subnet", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "account who will own the IPv4 subnet", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "UUID of the zone which the IPv4 subnet belongs to.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "project who will own the IPv4 subnet", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": false, + "type": "uuid" + } + ], + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "response": [ + {}, + { + "description": "the project name of the IPv4 subnet", + "name": "project", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { - "description": "state of the disk offering", - "name": "state", + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" + }, + { + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", + "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.20.0" }, { "description": "Lists details of network protocols", @@ -46607,16 +46607,6 @@ ], "related": "", "response": [ - { - "description": "the details of the protocol parameter", - "name": "details", - "type": "map" - }, - { - "description": "the description of the protocol parameter", - "name": "description", - "type": "string" - }, { "description": "the name of the protocol parameter", "name": "name", @@ -46627,18 +46617,28 @@ "name": "index", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the protocol parameter", + "name": "description", "type": "string" }, + { + "description": "the details of the protocol parameter", + "name": "details", + "type": "map" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.19.0" }, @@ -46647,21 +46647,6 @@ "isasync": false, "name": "listLBHealthCheckPolicies", "params": [ - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the ID of the health check policy", "length": 255, @@ -46678,6 +46663,14 @@ "required": false, "type": "string" }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -46692,20 +46685,52 @@ "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "createLBHealthCheckPolicy", "response": [ + { + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, {}, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ + { + "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": "the pingpath of the healthcheck policy", "name": "pingpath", @@ -46716,11 +46741,6 @@ "name": "id", "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", @@ -46732,20 +46752,15 @@ "type": "string" }, { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" }, { "description": "Number of consecutive health check failures before declaring an instance unhealthy.", "name": "unhealthcheckthresshold", "type": "int" }, - { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" - }, { "description": "Number of consecutive health check success before declaring an instance healthy", "name": "healthcheckthresshold", @@ -46754,37 +46769,22 @@ ], "type": "list" }, - { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" - }, { "description": "the domain ID of the HealthCheck policy", "name": "domainid", "type": "string" }, - {}, - { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, - { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" - } + {} ], "since": "4.2.0" }, @@ -46793,21 +46793,6 @@ "isasync": true, "name": "migrateVirtualMachineWithVolume", "params": [ - { - "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": "migrateto", - "required": false, - "type": "map" - }, - { - "description": "Destination Host ID to migrate VM to.", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", - "required": false, - "type": "uuid" - }, { "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", "length": 255, @@ -46820,126 +46805,108 @@ "description": "the ID of the virtual machine", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "response": [ - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "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": "migrateto", + "required": false, + "type": "map" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, + "description": "Destination Host ID to migrate VM to.", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + } + ], + "related": "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 list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "the project name of the affinity group", + "name": "project", "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the account owning the affinity group", + "name": "account", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "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": "true if nic is default, false otherwise", @@ -46947,28 +46914,28 @@ "type": "string" }, { - "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": "the gateway of the nic", - "name": "gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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": "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", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -46977,8 +46944,8 @@ "type": "integer" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -46991,161 +46958,152 @@ "name": "ip6cidr", "type": "string" }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, { "description": "the name of the corresponding network", "name": "networkname", "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", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ + }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "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 type of the affinity group", - "name": "type", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" } ], "type": "set" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - {}, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, - {}, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { @@ -47154,84 +47112,133 @@ "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, + {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "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 ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, + {}, { - "description": "the project name of the vm", - "name": "project", - "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": "id of the resource", + "name": "resourceid", + "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 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" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { "description": "the ID of the availability zone for the virtual machine", @@ -47239,138 +47246,57 @@ "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, + {}, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "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": "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": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { "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 description of the security group", - "name": "description", - "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": "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": "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" - }, - { - "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" - } - ], - "type": "set" - }, { "description": "the project name of the group", "name": "project", "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 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", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "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", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -47378,58 +47304,58 @@ "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "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": "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 domain associated with the tag", + "name": "domain", "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" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], @@ -47441,104 +47367,211 @@ "type": "string" }, { - "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 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": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" } ], "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 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", + "name": "id", + "type": "string" + }, { "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "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": "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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "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 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 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": "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "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": "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", @@ -47549,194 +47582,161 @@ "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": "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "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 ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "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 account owning the security group", - "name": "account", - "type": "string" } ], "type": "set" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "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": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "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 name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "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": "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" - }, - { - "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 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 state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the user's name who deployed the virtual machine", - "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "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": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "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", @@ -47744,33 +47744,23 @@ "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -47779,54 +47769,49 @@ "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "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 vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "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": "publicip", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "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", + "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 name of the user vm; this parameter is returned to the ROOT admin only", @@ -47834,89 +47819,104 @@ "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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 ID of the virtual machine", - "name": "groupid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "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": "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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 name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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 date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "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": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" } ] }, @@ -47926,18 +47926,19 @@ "name": "updateUser", "params": [ { - "description": "last name", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "lastname", + "name": "timezone", "required": false, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "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": "timezone", + "name": "mandate2fa", "required": false, - "type": "string" + "since": "4.18.0.0", + "type": "boolean" }, { "description": "first name", @@ -47947,12 +47948,11 @@ "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", + "description": "Unique username", "length": 255, - "name": "mandate2fa", + "name": "username", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "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", @@ -47962,11 +47962,12 @@ "type": "string" }, { - "description": "Current password that was being used by the user. You must inform the current password when updating the password.", + "description": "User uuid", "length": 255, - "name": "currentpassword", - "required": false, - "type": "string" + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" }, { "description": "The API key for the user. Must be specified with userSecretKey", @@ -47976,31 +47977,30 @@ "type": "string" }, { - "description": "email", + "description": "Current password that was being used by the user. You must inform the current password when updating the password.", "length": 255, - "name": "email", + "name": "currentpassword", "required": false, "type": "string" }, { - "description": "User uuid", + "description": "The secret key for the user. Must be specified with userApiKey", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, - "type": "uuid" + "name": "usersecretkey", + "required": false, + "type": "string" }, { - "description": "Unique username", + "description": "email", "length": 255, - "name": "username", + "name": "email", "required": false, "type": "string" }, { - "description": "The secret key for the user. Must be specified with userApiKey", + "description": "last name", "length": 255, - "name": "usersecretkey", + "name": "lastname", "required": false, "type": "string" } @@ -48008,23 +48008,23 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", "response": [ { - "description": "the timezone user was created in", - "name": "timezone", - "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 lastname", + "name": "lastname", "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 domain name of the user", - "name": "domain", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -48032,36 +48032,25 @@ "name": "accountid", "type": "string" }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - {}, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, { "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 api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the user state", - "name": "state", + "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 name of the user", + "name": "account", + "type": "string" }, { "description": "the name of the role", @@ -48069,33 +48058,35 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the user state", + "name": "state", "type": "string" }, + {}, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "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 ID of the role", - "name": "roleid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { @@ -48104,13 +48095,13 @@ "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "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" }, { @@ -48124,8 +48115,8 @@ "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -48133,11 +48124,20 @@ "name": "isdefault", "type": "boolean" }, - {}, { - "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" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" } ] }, @@ -48150,7 +48150,7 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule", "required": true, "type": "uuid" } @@ -48161,6 +48161,8 @@ "name": "success", "type": "boolean" }, + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -48171,13 +48173,11 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -48186,27 +48186,34 @@ "name": "addHost", "params": [ { - "description": "the host URL", + "description": "the cluster name for the host", "length": 255, - "name": "url", - "required": true, + "name": "clustername", + "required": false, "type": "string" }, { - "description": "the cluster ID for the host", + "description": "the Zone ID for the host", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "password", + "name": "allocationstate", "required": false, "type": "string" }, + { + "description": "the host URL", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, { "description": "hypervisor type of the host", "length": 255, @@ -48215,18 +48222,19 @@ "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "the Pod ID for the host", "length": 255, - "name": "hosttags", - "required": false, - "type": "list" + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the Zone ID for the host", + "description": "the cluster ID for the host", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, "type": "uuid" }, { @@ -48237,29 +48245,21 @@ "type": "string" }, { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the cluster name for the host", + "description": "list of tags to be added to the host", "length": 255, - "name": "clustername", + "name": "hosttags", "required": false, - "type": "string" + "type": "list" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "allocationstate", + "name": "password", "required": false, "type": "string" } ], - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ { "description": "the OS category name of the host", @@ -48267,108 +48267,108 @@ "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the host hypervisor", + "name": "hypervisor", "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 cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { @@ -48377,116 +48377,108 @@ "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "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 IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "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 after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, + {}, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "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": "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", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { @@ -48495,18 +48487,23 @@ "type": "string" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { @@ -48515,41 +48512,25 @@ "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "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 management server ID of the host", - "name": "managementserverid", - "type": "string" - }, - { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "type": "string" - }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { "description": "the amount of the host's memory currently allocated in bytes", @@ -48557,54 +48538,43 @@ "type": "long" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "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 ID of the host", - "name": "id", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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", + "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" }, { @@ -48613,23 +48583,38 @@ "type": "date" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" }, { @@ -48638,19 +48623,34 @@ "type": "date" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" } ] }, @@ -48660,10 +48660,10 @@ "name": "attachVolume", "params": [ { - "description": "the ID of the disk volume", + "description": " the ID of the virtual machine", "length": 255, - "name": "id", - "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "virtualmachineid", + "related": "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" }, @@ -48675,240 +48675,165 @@ "type": "long" }, { - "description": " the ID of the virtual machine", + "description": "the ID of the disk volume", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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": "uuid" } ], - "related": "importVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ + {}, { - "description": "name of the availability zone", - "name": "zonename", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "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": "name of the disk offering", - "name": "diskofferingname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "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 path of the volume", - "name": "path", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - {}, { "description": "ID of the snapshot from which this volume was created", "name": "snapshotid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "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", + "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the path of the volume", + "name": "path", "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 display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "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": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, { "description": "the project id of the vpn", "name": "projectid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "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", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { @@ -48916,38 +48841,38 @@ "name": "tags", "response": [ { - "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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "tag key name", - "name": "key", + "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", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -48956,51 +48881,67 @@ "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": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + {}, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { @@ -49009,28 +48950,38 @@ "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "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", "type": "string" }, { @@ -49039,75 +48990,124 @@ "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "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 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 date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "pod name of the volume", + "name": "podname", + "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 disk volume", + "name": "state", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", "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", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "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", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" } ] }, @@ -49116,6 +49116,13 @@ "isasync": true, "name": "updateProject", "params": [ + { + "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, @@ -49124,12 +49131,11 @@ "type": "boolean" }, { - "description": "ID of the user to be promoted/demoted", + "description": "display text of the project", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { "description": "id of the project to be modified", @@ -49140,66 +49146,51 @@ "type": "uuid" }, { - "description": "Account level role to be assigned to the user/account : Admin/Regular", - "length": 255, - "name": "roletype", - "required": false, - "type": "string" - }, - { - "description": "name of the project", + "description": "new Admin account for the project", "length": 255, - "name": "name", + "name": "account", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "display text of the project", + "description": "ID of the user to be promoted/demoted", "length": 255, - "name": "displaytext", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "new Admin account for the project", + "description": "name of the project", "length": 255, - "name": "account", + "name": "name", "required": false, + "since": "4.19.0", "type": "string" } ], "related": "activateProject,createProject,suspendProject", "response": [ { - "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 id of the project", - "name": "id", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" }, + {}, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the name of the project", + "name": "name", + "type": "string" }, { "description": "the total number of templates which can be created by this project", @@ -49207,80 +49198,125 @@ "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, - {}, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, { "description": "the date this project was created", "name": "created", "type": "date" }, { - "description": "the name of the project", - "name": "name", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "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 available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "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": "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": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, - {}, { "description": "the total number of public ip addresses allocated for this project", "name": "iptotal", "type": "long" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the id of the project", + "name": "id", "type": "string" }, { @@ -49289,33 +49325,28 @@ "type": "long" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { @@ -49323,45 +49354,60 @@ "name": "networktotal", "type": "long" }, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "The tagged resource limit and count for the project", "name": "taggedresources", "type": "list" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { "description": "the total primary storage space (in GiB) the project can own", @@ -49369,86 +49415,40 @@ "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + {}, + { + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "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 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 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": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" }, { "description": "the state of the project", @@ -49456,24 +49456,24 @@ "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "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 the project can own", - "name": "networklimit", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" } ], "since": "3.0.0" @@ -49484,32 +49484,12 @@ "name": "listLoadBalancers", "params": [ { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "the name of the load balancer", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the scheme of the load balancer. Supported value is internal in the current release", + "description": "the ID of the load balancer", "length": 255, - "name": "scheme", + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the network ID of the source IP address", @@ -49520,26 +49500,25 @@ "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 resources by tags (key/value pairs)", "length": 255, - "name": "listall", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the network ID of the load balancer", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "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": "the source IP address of the load balancer", @@ -49549,24 +49528,26 @@ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the name of the load balancer", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "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" }, { @@ -49578,138 +49559,88 @@ "type": "uuid" }, { - "description": "the ID of the load balancer", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the scheme of the load balancer. Supported value is internal in the current release", "length": 255, - "name": "fordisplay", + "name": "scheme", "required": false, - "since": "4.4", - "type": "boolean" - } - ], - "related": "createLoadBalancer", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, { - "description": "the account of the Load Balancer", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, "name": "account", + "required": false, "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "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": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "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" + } + ], + "related": "createLoadBalancer", + "response": [ + { + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, - {}, { "description": "is rule for display to the regular user", "name": "fordisplay", "type": "boolean" }, + {}, { - "description": "the name of the Load Balancer", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "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": "Load Balancer source ip", "name": "sourceipaddress", "type": "string" }, - {}, - { - "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", - "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" - } - ], - "type": "list" + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" }, + {}, { "description": "the list of resource tags associated with the Load Balancer", "name": "tags", @@ -49720,43 +49651,43 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "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": "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": "resource type", - "name": "resourcetype", + "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" }, { @@ -49765,21 +49696,41 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the Load Balancer ID", "name": "id", "type": "string" }, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "the project name of the Load Balancer", + "name": "project", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, { @@ -49788,14 +49739,63 @@ "type": "string" }, { - "description": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the instance ID", + "name": "id", + "type": "string" + }, + { + "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" + } + ], + "type": "list" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", + "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": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + } + ], + "type": "list" } ], "since": "4.2.0" @@ -49817,27 +49817,27 @@ "related": "getUserKeys", "response": [ { - "description": "the secret key of the registered user", - "name": "secretkey", + "description": "the api key of the registered user", + "name": "apikey", "type": "string" }, - {}, { - "description": "the api key of the registered user", - "name": "apikey", + "description": "the secret key of the registered user", + "name": "secretkey", "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" - }, - {} + } ] }, { @@ -49855,27 +49855,27 @@ } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "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": "3.0.0" @@ -49886,63 +49886,71 @@ "name": "listVpnConnections", "params": [ { - "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": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "id of vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "id of the vpn connection", "length": 255, - "name": "fordisplay", + "name": "id", + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "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.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "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": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "id of the vpn connection", + "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", - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -49953,32 +49961,24 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "id of vpc", + "description": "", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createVpnConnection,updateVpnConnection", "response": [ { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id", + "name": "projectid", + "type": "string" }, { "description": "the domain id of the owner", @@ -49986,33 +49986,44 @@ "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "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": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the project name", + "name": "project", + "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the connection ID", + "name": "id", "type": "string" }, { @@ -50021,13 +50032,13 @@ "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { @@ -50036,82 +50047,71 @@ "type": "boolean" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "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": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, + {}, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, - {}, { "description": "the customer gateway ID", "name": "s2scustomergatewayid", "type": "string" - }, - { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" - }, - { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" - }, - {} + } ] }, { @@ -50119,14 +50119,6 @@ "isasync": true, "name": "removeTungstenFabricPolicy", "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - }, { "description": "the uuid of Tungsten-Fabric policy", "length": 255, @@ -50140,48 +50132,56 @@ "name": "networkuuid", "required": true, "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" } ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy", "response": [ + {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, - {}, - { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, + {}, + {}, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "Tungsten-Fabric tag type 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 policy name", + "name": "name", + "type": "string" + } ] }, { @@ -50190,10 +50190,10 @@ "name": "updateCloudToUseObjectStore", "params": [ { - "description": "the image store provider name", + "description": "the name for the image store", "length": 255, - "name": "provider", - "required": true, + "name": "name", + "required": false, "type": "string" }, { @@ -50204,36 +50204,42 @@ "type": "map" }, { - "description": "the URL for the image store", + "description": "the image store provider name", "length": 255, - "name": "url", - "required": false, + "name": "provider", + "required": true, "type": "string" }, { - "description": "the name for the image store", + "description": "the URL for the image store", "length": 255, - "name": "name", + "name": "url", "required": false, "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", "response": [ + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, { "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 host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the url of the image store", + "name": "url", + "type": "string" }, { "description": "defines if store is read-only", @@ -50241,56 +50247,50 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", - "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 protocol of the image store", + "name": "protocol", + "type": "string" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - { - "description": "the ID of the image store", - "name": "id", - "type": "string" - }, + {}, { "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 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 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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" } ], "since": "4.3.0" @@ -50326,13 +50326,8 @@ "related": "listASNRanges", "response": [ { - "description": "Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "End AS Number", - "name": "endasn", + "description": "Start AS Number", + "name": "startasn", "type": "long" }, { @@ -50340,28 +50335,33 @@ "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "Created date", + "name": "created", + "type": "date" + }, { "description": "ID of the AS Number Range", "name": "id", "type": "string" }, { - "description": "Start AS Number", - "name": "startasn", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "End AS Number", + "name": "endasn", "type": "long" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, - { - "description": "Created date", - "name": "created", - "type": "date" - } + {} ], "since": "4.20.0" }, @@ -50371,19 +50371,19 @@ "name": "addTungstenFabricNetworkGatewayToLogicalRouter", "params": [ { - "description": "the ID of zone", + "description": "Tungsten-Fabric network uuid", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "networkuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric network uuid", + "description": "the ID of zone", "length": 255, - "name": "networkuuid", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Tungsten-Fabric logical router uuid", @@ -50396,24 +50396,24 @@ "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter,listTungstenFabricLogicalRouter", "response": [ { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", + "description": "Tungsten-Fabric logical router name", + "name": "name", "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 logical router name", - "name": "name", + "description": "Tungsten-Fabric logical router 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" }, {}, { @@ -50421,17 +50421,17 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" - }, - {} + } ] }, { @@ -50440,11 +50440,12 @@ "name": "listTungstenFabricNic", "params": [ { - "description": "the uuid of Tungsten-Fabric nic", + "description": "the ID of zone", "length": 255, - "name": "nicuuid", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -50454,17 +50455,16 @@ "type": "integer" }, { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric nic", "length": 255, - "name": "keyword", + "name": "nicuuid", "required": false, "type": "string" }, @@ -50478,6 +50478,12 @@ ], "related": "", "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Tungsten-Fabric nic name", "name": "name", @@ -50494,22 +50500,16 @@ "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 nic uuid", "name": "uuid", "type": "string" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -50518,18 +50518,11 @@ "name": "listVmwareDcs", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "Id of the CloudStack zone.", @@ -50540,18 +50533,25 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "addVmwareDc", "response": [ { - "description": "The VMware Datacenter name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -50560,26 +50560,26 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 VMware Datacenter ID", + "name": "id", + "type": "string" }, { "description": "The VMware vCenter name/ip", "name": "vcenter", "type": "string" }, + {}, + {}, { - "description": "The VMware Datacenter ID", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -50589,18 +50589,12 @@ "name": "applyTungstenFabricPolicy", "params": [ { - "description": "the major sequence of Tungsten-Fabric policy", - "length": 255, - "name": "majorsequence", - "required": true, - "type": "integer" - }, - { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the ID of zone", "length": 255, - "name": "policyuuid", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "the minor sequence of Tungsten-Fabric policy", @@ -50617,25 +50611,26 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "the major sequence of Tungsten-Fabric policy", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "majorsequence", "required": true, - "type": "uuid" + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" } ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy", "response": [ { - "description": "Tungsten-Fabric policy 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" }, {}, { @@ -50643,28 +50638,33 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + }, { "description": "list Tungsten-Fabric policy network name", "name": "network", "type": "list" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" - } + }, + {} ] }, { @@ -50673,41 +50673,43 @@ "name": "listZones", "params": [ { - "description": "the name of the zone", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "name", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "flag to display the capacity of the zones", + "description": "List zones by resource tags (key/value pairs)", "length": 255, - "name": "showcapacities", + "name": "tags", "required": false, - "type": "boolean" + "since": "4.3", + "type": "map" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the ID of the domain associated with the zone", + "description": "the name of the zone", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "the IDs of the zones, mutually exclusive with id", "length": 255, - "name": "tags", + "name": "ids", + "related": "createZone,listZones,listZones", "required": false, - "since": "4.3", - "type": "map" + "since": "4.19.0", + "type": "list" }, { "description": "the network type of the zone that the virtual machine belongs to", @@ -50725,278 +50727,266 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "flag to display the resource image for the zones", "length": 255, - "name": "keyword", + "name": "showicon", "required": false, - "type": "string" + "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.", + "description": "List by keyword", "length": 255, - "name": "available", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the IDs of the zones, mutually exclusive with id", + "description": "", "length": 255, - "name": "ids", - "related": "createZone,listZones,listZones", + "name": "page", "required": false, - "since": "4.19.0", - "type": "list" + "type": "integer" }, { - "description": "flag to display the resource image for the zones", + "description": "flag to display the capacity of the zones", "length": 255, - "name": "showicon", + "name": "showcapacities", "required": false, "type": "boolean" }, { - "description": "", + "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": "pagesize", + "name": "available", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "createZone,listZones", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" - }, - { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" - }, - { - "description": "Zone Token", - "name": "zonetoken", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "The tag for the capacity type", + "name": "tag", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "AS Number Range", + "name": "asnrange", + "type": "string" + }, + { + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" + }, + {}, + { + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" + }, + { + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the network type of the zone; can be Basic or Advanced", "name": "networktype", "type": "string" }, - {}, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod name", - "name": "podname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "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": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, + { + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, { @@ -51004,61 +50994,71 @@ "name": "domainid", "type": "string" }, - {}, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, + {}, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" }, { - "description": "Zone name", - "name": "name", + "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 second DNS for the Zone", - "name": "dns2", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" + }, + { + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" } ] }, @@ -51098,19 +51098,29 @@ "type": "date" }, { - "description": "ID of the quarantine process.", - "name": "id", + "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", + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, {}, { - "description": "End date for the quarantine.", - "name": "enddate", + "description": "When the quarantine was removed.", + "name": "removed", "type": "date" }, { @@ -51119,35 +51129,25 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, {}, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" + "description": "ID of the quarantine process.", + "name": "id", + "type": "string" }, { "description": "Account ID of the previous public IP address owner.", "name": "previousownerid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", - "type": "string" } ], "since": "4.19" @@ -51167,27 +51167,27 @@ } ], "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ] }, @@ -51196,6 +51196,14 @@ "isasync": false, "name": "listNetscalerLoadBalancerNetworks", "params": [ + { + "description": "netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "required": true, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -51210,14 +51218,6 @@ "required": false, "type": "integer" }, - { - "description": "netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, - "type": "uuid" - }, { "description": "", "length": 255, @@ -51229,84 +51229,53 @@ "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "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 first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the id of the network", + "name": "id", "type": "string" }, - {}, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "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": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "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": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { @@ -51320,107 +51289,107 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the name of the network", - "name": "name", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", "type": "set" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" }, { "description": "the list of resource tags associated with network", "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" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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" }, { @@ -51429,33 +51398,33 @@ "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": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -51467,35 +51436,131 @@ "type": "list" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "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", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "list networks that are persistent", + "name": "ispersistent", + "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": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "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.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, { "description": "the list of services", "name": "service", @@ -51514,15 +51579,15 @@ "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" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" } ], "type": "list" @@ -51532,18 +51597,13 @@ "name": "provider", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -51552,8 +51612,8 @@ "type": "list" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -51562,9 +51622,14 @@ "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" @@ -51573,94 +51638,80 @@ "type": "list" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "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": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "The external id of the network", + "name": "externalid", "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", + "description": "ACL name associated with the VPC network", + "name": "aclname", "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the type of the network", - "name": "type", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" }, { "description": "the displaytext of the network", @@ -51668,64 +51719,33 @@ "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "true network requires restart", - "name": "restartrequired", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the owner of the network", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, - {}, { - "description": "state of the network", - "name": "state", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { @@ -51734,29 +51754,9 @@ "type": "boolean" }, { - "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": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" } ] }, @@ -51775,85 +51775,29 @@ } ], "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" }, - {} - ] - }, - { - "description": "Lists host HA resources", - "isasync": false, - "name": "listHostHAResources", - "params": [ - { - "description": "List by host ID", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", - "required": false, - "type": "uuid" - } - ], - "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", - "response": [ - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, - {}, - { - "description": "operation status", - "name": "status", - "type": "boolean" - }, - {}, - { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the host HA provider", - "name": "haprovider", - "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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } - ], - "since": "4.11" + ] }, { "description": "Lists supported methods of network isolation", @@ -51884,15 +51828,50 @@ ], "related": "", "response": [ + {}, + { + "description": "Network isolation method name", + "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", "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "Lists host HA resources", + "isasync": false, + "name": "listHostHAResources", + "params": [ + { + "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 host HA provider", + "name": "haprovider", + "type": "string" }, { - "description": "Network isolation method name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -51900,9 +51879,30 @@ "name": "jobstatus", "type": "integer" }, - {} + { + "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 HA state of the host", + "name": "hastate", + "type": "hastate" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" + } ], - "since": "4.2.0" + "since": "4.11" }, { "description": "list Tungsten-Fabric firewall policy", @@ -51910,25 +51910,25 @@ "name": "listTungstenFabricFirewallPolicy", "params": [ { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "keyword", + "name": "firewallpolicyuuid", "required": false, "type": "string" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "page", + "name": "applicationpolicysetuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "", "length": 255, - "name": "firewallpolicyuuid", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "the ID of zone", @@ -51939,27 +51939,26 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "", "length": 255, - "name": "applicationpolicysetuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "createTungstenFabricFirewallPolicy", "response": [ - {}, { - "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 firewall policy uuid", @@ -51968,29 +51967,30 @@ }, {}, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", - "type": "string" - }, - { - "description": "list Tungsten-Fabric firewall rule", - "name": "firewallrule", - "type": "list" + "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", "type": "string" }, + { + "description": "Tungsten-Fabric firewall policy 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": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" } ] }, @@ -51999,13 +51999,6 @@ "isasync": true, "name": "deleteDomain", "params": [ - { - "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" - }, { "description": "ID of domain to delete", "length": 255, @@ -52013,31 +52006,38 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" + }, + { + "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" } ], "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 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", - "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" + } ] }, { @@ -52053,6 +52053,14 @@ "required": true, "type": "uuid" }, + { + "description": "the ID of the volume", + "length": 255, + "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": "if the volume should be live migrated when it is attached to a running vm", "length": 255, @@ -52067,101 +52075,166 @@ "related": "", "required": false, "type": "uuid" - }, - { - "description": "the ID of the volume", - "length": 255, - "name": "volumeid", - "related": "importVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": true, - "type": "uuid" } ], - "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "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": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "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 boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "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": "the disk utilization", - "name": "utilization", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, + {}, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "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": "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": "tag key name", + "name": "key", + "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 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" + } + ], + "type": "set" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "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": "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": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { @@ -52169,76 +52242,81 @@ "name": "vmdisplayname", "type": "string" }, + {}, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "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": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, - {}, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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 virtual machine", - "name": "vmname", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "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": "details for the volume repair result, they may vary for different hypervisors", @@ -52246,43 +52324,28 @@ "type": "map" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "the state of the disk volume", - "name": "state", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -52291,217 +52354,154 @@ "type": "long" }, { - "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 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": "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": "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 id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "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": "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, - {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the disk utilization", + "name": "utilization", "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 chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "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": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the state of the disk volume", + "name": "state", + "type": "string" } ], "since": "3.0.0" @@ -52511,13 +52511,6 @@ "isasync": true, "name": "createTungstenFabricApplicationPolicySet", "params": [ - { - "description": "Tungsten-Fabric application policy set name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -52525,36 +52518,38 @@ "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": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" }, { "description": "Tungsten-Fabric policy name", "name": "name", "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", "type": "string" }, - { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", - "type": "string" - }, + {}, { "description": "list Tungsten-Fabric firewall policy", "name": "firewallpolicy", @@ -52565,178 +52560,103 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" - } - ] - }, - { - "description": "Deletes an existing Bgp Peer.", - "isasync": true, - "name": "deleteBgpPeer", - "params": [ - { - "description": "Id of the Bgp Peer", - "length": 255, - "name": "id", - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", - "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": "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.20.0" + {} + ] }, { - "description": "Lists HA providers", + "description": "A command to list events.", "isasync": false, - "name": "listHostHAProviders", + "name": "listEvents", "params": [ { - "description": "Hypervisor type of the resource", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - } - ], - "related": "configureHAForHost,enableHAForHost,disableHAForHost", - "response": [ - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, - { - "description": "the ID of the host", - "name": "hostid", - "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 host HA provider", - "name": "haprovider", - "type": "string" - }, - { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, - {}, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": false, + "type": "uuid" }, - {} - ], - "since": "4.11" - }, - { - "description": "A command to list events.", - "isasync": false, - "name": "listEvents", - "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the time the event was entered", + "description": "the ID of the event", "length": 255, - "name": "entrytime", + "name": "id", + "related": "listEvents", "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.", + "description": "the duration of the event", "length": 255, - "name": "listall", + "name": "duration", "required": false, - "type": "boolean" + "type": "integer" }, { - "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\")", + "description": "the event type (see event types)", "length": 255, - "name": "enddate", + "name": "type", "required": false, - "type": "date" + "type": "string" }, { - "description": "the ID of the resource associated with the event", + "description": "", "length": 255, - "name": "resourceid", + "name": "page", "required": false, - "since": "4.17.0", - "type": "string" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the event type (see event types)", + "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": "type", + "name": "enddate", "required": false, - "type": "string" + "type": "date" }, { - "description": "the event level (INFO, WARN, ERROR)", + "description": "the time the event was entered", "length": 255, - "name": "level", + "name": "entrytime", "required": false, - "type": "string" + "type": "integer" }, { - "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 type of the resource associated with the event", @@ -52746,14 +52666,6 @@ "since": "4.17.0", "type": "string" }, - { - "description": "true to list archived events otherwise false", - "length": 255, - "name": "archived", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, { "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, @@ -52770,55 +52682,68 @@ "type": "date" }, { - "description": "the ID of the event", + "description": "the event level (INFO, WARN, ERROR)", "length": 255, - "name": "id", - "related": "listEvents", + "name": "level", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "true to list archived events otherwise false", "length": 255, - "name": "account", + "name": "archived", "required": false, - "type": "string" + "since": "4.19.0", + "type": "boolean" }, { - "description": "the duration of the event", + "description": "the ID of the resource associated with the event", "length": 255, - "name": "duration", + "name": "resourceid", "required": false, - "type": "integer" + "since": "4.17.0", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "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" } ], "related": "", "response": [ { - "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 state of the event", + "name": "state", + "type": "state" + }, + { + "description": "the type of the resource", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the date the event 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 resource", + "name": "resourceid", "type": "string" }, { @@ -52827,18 +52752,24 @@ "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", - "name": "level", + "description": "the ID of the event", + "name": "id", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "path of the Domain the account's domain belongs to", + "name": "domainpath", "type": "string" }, + {}, + { + "description": "whether the event has been archived or not", + "name": "archived", + "type": "boolean" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" }, { @@ -52846,79 +52777,148 @@ "name": "domainid", "type": "string" }, - {}, - { - "description": "the state of the event", - "name": "state", - "type": "state" - }, { - "description": "whether the event has been archived or not", - "name": "archived", - "type": "boolean" + "description": "the name of the account's domain", + "name": "domain", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "a brief description of the event", + "name": "description", + "type": "string" }, { - "description": "the date the event was created", - "name": "created", - "type": "date" + "description": "the name of the resource", + "name": "resourcename", + "type": "string" }, { - "description": "path of the Domain the account's domain belongs to", - "name": "domainpath", + "description": "the event level (INFO, WARN, ERROR)", + "name": "level", "type": "string" }, { - "description": "the ID of the event", - "name": "id", + "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 id of the resource", - "name": "resourceid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + {}, { - "description": "a brief description of the event", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the resource", - "name": "resourcetype", + "description": "the project name of the address", + "name": "project", "type": "string" }, { "description": "the type of the event (see event types)", "name": "type", "type": "string" + } + ] + }, + { + "description": "Deletes an existing Bgp Peer.", + "isasync": true, + "name": "deleteBgpPeer", + "params": [ + { + "description": "Id of the Bgp Peer", + "length": 255, + "name": "id", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "any text associated with the success or failure", + "name": "displaytext", "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 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": "Lists HA providers", + "isasync": false, + "name": "listHostHAProviders", + "params": [ + { + "description": "Hypervisor type of the resource", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" + } + ], + "related": "configureHAForHost,enableHAForHost,disableHAForHost", + "response": [ + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" }, {}, { - "description": "the name of the account's domain", - "name": "domain", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the name of the resource", - "name": "resourcename", + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "the host HA provider", + "name": "haprovider", "type": "string" } - ] + ], + "since": "4.11" }, { "description": "Creates resource tag(s)", @@ -52926,11 +52926,11 @@ "name": "createTags", "params": [ { - "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "customer", - "required": false, - "type": "string" + "name": "tags", + "required": true, + "type": "map" }, { "description": "list of resources to create the tags for", @@ -52940,42 +52940,42 @@ "type": "list" }, { - "description": "Map of tags (key/value pairs)", + "description": "type of the resource", "length": 255, - "name": "tags", + "name": "resourcetype", "required": true, - "type": "map" + "type": "string" }, { - "description": "type of the resource", + "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", "length": 255, - "name": "resourcetype", - "required": true, + "name": "customer", + "required": false, "type": "string" } ], "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 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.0.0" @@ -52996,28 +52996,28 @@ ], "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", "response": [ - {}, { - "description": "the id of the internal load balancer element", - "name": "id", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the internal load balancer element", + "name": "id", "type": "string" }, + { + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" + }, + {}, + {}, { "description": "the physical network service provider id of the element", "name": "nspid", @@ -53041,10 +53041,16 @@ } ], "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", @@ -53052,17 +53058,11 @@ "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" - } + {} ] }, { @@ -53080,27 +53080,27 @@ } ], "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": "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" } ] }, @@ -53109,13 +53109,6 @@ "isasync": true, "name": "generateAlert", "params": [ - { - "description": "Name of the alert", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "Zone id for which alert is generated", "length": 255, @@ -53124,6 +53117,20 @@ "required": false, "type": "uuid" }, + { + "description": "Type of the alert", + "length": 255, + "name": "type", + "required": true, + "type": "short" + }, + { + "description": "Name of the alert", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "Alert description", "length": 999, @@ -53138,37 +53145,30 @@ "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" - }, - { - "description": "Type of the alert", - "length": 255, - "name": "type", - "required": true, - "type": "short" } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.3" @@ -53179,32 +53179,32 @@ "name": "ldapConfig", "params": [ { - "description": "Enter the password.", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", "length": 255, - "name": "bindpass", + "name": "ssl", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Specify the LDAP port if required, default is 389.", + "description": "If true return current LDAP configuration", "length": 255, - "name": "port", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory.", + "description": "Enter the path to trust certificates store.", "length": 255, - "name": "binddn", + "name": "truststore", "required": false, "type": "string" }, { - "description": "If true return current LDAP configuration", + "description": "Specify the LDAP port if required, default is 389.", "length": 255, - "name": "listall", + "name": "port", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "Enter the password for trust store.", @@ -53221,39 +53221,40 @@ "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "description": "Specify the distinguished name of a user with the search permission on the directory.", "length": 255, - "name": "hostname", + "name": "binddn", "required": false, "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", "length": 255, - "name": "queryfilter", + "name": "hostname", "required": false, "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", + "description": "Enter the password.", "length": 255, - "name": "ssl", + "name": "bindpass", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Enter the path to trust certificates store.", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", "length": 255, - "name": "truststore", + "name": "queryfilter", "required": false, "type": "string" } ], "related": "ldapRemove", "response": [ + {}, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, { @@ -53261,14 +53262,19 @@ "name": "jobid", "type": "string" }, + { + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", + "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", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", "type": "string" }, { @@ -53277,27 +53283,21 @@ "type": "integer" }, { - "description": "DN password", - "name": "bindpass", - "type": "string" - }, - { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "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", + "description": "DN password", + "name": "bindpass", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -53317,42 +53317,42 @@ ], "related": "", "response": [ - {}, { "description": "the identifier of the Storage Policy in vSphere DataCenter", "name": "policyid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the Storage Policy", + "name": "description", "type": "string" }, { - "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 ID of the Storage Policy", "name": "id", "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 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" + }, + { + "description": "the ID of the Zone", + "name": "zoneid", + "type": "string" } ] }, @@ -53365,34 +53365,34 @@ "description": "the ID of the port forwarding rule", "length": 255, "name": "id", - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule", "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", "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" + } ] }, { @@ -53401,11 +53401,12 @@ "name": "migrateVPC", "params": [ { - "description": "true if previous network migration cmd failed", + "description": "vpc offering ID", "length": 255, - "name": "resume", - "required": false, - "type": "boolean" + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, + "type": "uuid" }, { "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", @@ -53415,12 +53416,11 @@ "type": "map" }, { - "description": "vpc offering ID", + "description": "true if previous network migration cmd failed", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering,listVPCOfferings", - "required": true, - "type": "uuid" + "name": "resume", + "required": false, + "type": "boolean" }, { "description": "the ID of the vpc", @@ -53439,83 +53439,104 @@ "type": "string" }, { - "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": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" - }, - { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, - { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", - "type": "string" + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, - { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, { "description": "AS NUMBER", "name": "asnumber", "type": "long" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", - "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 owner", - "name": "domain", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the owner of the VPC", - "name": "account", - "type": "string" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 value", + "name": "value", + "type": "string" + }, + { + "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" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "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": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { @@ -53524,193 +53545,140 @@ "type": "boolean" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "the owner of the VPC", + "name": "account", + "type": "string" + }, + { + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { "description": "is vpc for display to the regular user", "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, - {}, + { + "description": "the id of the VPC", + "name": "id", + "type": "string" + }, + { + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, { "description": "the list of resource tags associated with the project", "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": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 project name where tag belongs to", - "name": "project", + "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": "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the name of the zone the VPC belongs to", "name": "zonename", "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": "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": "the physical network this belongs to", - "name": "physicalnetworkid", - "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" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "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" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "the cidr the VPC", + "name": "cidr", + "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { @@ -53724,43 +53692,75 @@ "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "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": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" }, { - "description": "the id of the VPC", - "name": "id", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + {}, + { + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" } ], @@ -53791,17 +53791,17 @@ "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {} ] }, @@ -53811,47 +53811,41 @@ "name": "updateAnnotationVisibility", "params": [ { - "description": "the annotation is visible for admins only", + "description": "the id of the annotation", "length": 255, - "name": "adminsonly", + "name": "id", "required": true, - "type": "boolean" + "type": "string" }, { - "description": "the id of the annotation", + "description": "the annotation is visible for admins only", "length": 255, - "name": "id", + "name": "adminsonly", "required": true, - "type": "string" + "type": "boolean" } ], "related": "addAnnotation,listAnnotations,removeAnnotation", "response": [ - { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", - "type": "string" - }, { "description": "True if the annotation is available for admins only", "name": "adminsonly", "type": "boolean" }, - {}, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the contents of the annotation", @@ -53864,96 +53858,39 @@ "type": "date" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" - }, - { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "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 (uu)id of the annotation", + "name": "id", "type": "string" }, - {} - ], - "since": "4.16" - }, - { - "description": "Configures HA for a host", - "isasync": true, - "name": "configureHAForHost", - "params": [ - { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", - "required": true, - "type": "uuid" - }, - { - "description": "HA provider", - "length": 255, - "name": "provider", - "required": true, - "type": "string" - } - ], - "related": "enableHAForHost,disableHAForHost", - "response": [ - {}, {}, { - "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 type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "operation status", - "name": "status", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, - { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], - "since": "4.11" + "since": "4.16" }, { "description": "Updates a configuration.", @@ -53961,18 +53898,18 @@ "name": "updateConfiguration", "params": [ { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, @@ -53992,18 +53929,18 @@ "type": "string" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "zoneid", + "related": "createZone,listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, @@ -54015,10 +53952,10 @@ "type": "string" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "imagestoreuuid", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", "required": false, "type": "uuid" } @@ -54026,8 +53963,13 @@ "related": "listConfigurations", "response": [ { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the component of the configuration", + "name": "component", + "type": "string" + }, + { + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { @@ -54035,98 +53977,170 @@ "name": "description", "type": "string" }, + { + "description": "the default value of the configuration", + "name": "defaultvalue", + "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", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the display text of the configuration", + "name": "displaytext", + "type": "string" + }, + { + "description": "the subgroup of the configuration", + "name": "subgroup", + "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": "the category of the configuration", - "name": "category", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, - {}, { - "description": "the value of the configuration", - "name": "id", - "type": "long" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the name of the configuration", - "name": "name", + "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 category of the configuration", + "name": "category", "type": "string" }, + {}, { - "description": "the type of the configuration value", - "name": "type", + "description": "the group of the configuration", + "name": "group", + "type": "string" + } + ] + }, + { + "description": "Configures HA for a host", + "isasync": true, + "name": "configureHAForHost", + "params": [ + { + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + }, + { + "description": "HA provider", + "length": 255, + "name": "provider", + "required": true, "type": "string" + } + ], + "related": "enableHAForHost,disableHAForHost", + "response": [ + { + "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", "type": "string" }, + {}, { - "description": "the group of the configuration", - "name": "group", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the ID of the host", + "name": "hostid", "type": "string" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.11" }, { "description": "Lists volume stats", "isasync": false, "name": "listVolumesUsageHistory", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the ID of the volume.", "length": 255, "name": "id", - "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, "type": "uuid" }, + { + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, { "description": "", "length": 255, @@ -54142,11 +54156,12 @@ "type": "date" }, { - "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", + "description": "the IDs of the volumes, mutually exclusive with id.", "length": 255, - "name": "name", + "name": "ids", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, - "type": "string" + "type": "list" }, { "description": "", @@ -54156,26 +54171,11 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", "length": 255, - "name": "keyword", + "name": "name", "required": false, "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 IDs of the volumes, mutually exclusive with id.", - "length": 255, - "name": "ids", - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": false, - "type": "list" } ], "related": "", @@ -54185,12 +54185,12 @@ "name": "stats", "type": "list" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the ID of the volume", "name": "id", @@ -54201,12 +54201,12 @@ "name": "name", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ], "since": "4.18.0" }, @@ -54216,20 +54216,13 @@ "name": "dedicatePublicIpRange", "params": [ { - "description": "project who will own the VLAN", + "description": "the id of the VLAN IP range", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", - "required": false, + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", + "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, @@ -54239,95 +54232,107 @@ "type": "uuid" }, { - "description": "the id of the VLAN IP range", + "description": "account who will own the VLAN", "length": 255, - "name": "id", - "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", - "required": true, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": false, "type": "uuid" } ], "related": "createVlanIpRange,updateVlanIpRange", "response": [ { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", - "type": "string" + "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": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, - {}, { "description": "the domain ID of the VLAN IP range", "name": "domainid", "type": "string" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", - "type": "boolean" + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" }, + {}, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "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", + "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", + "description": "the start ip of the VLAN IP range", + "name": "startip", + "type": "string" + }, + { + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { @@ -54335,35 +54340,39 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "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", + "description": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", "type": "boolean" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { @@ -54372,26 +54381,57 @@ "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, + {} + ] + }, + { + "description": "Deletes an empty Bucket.", + "isasync": false, + "name": "deleteBucket", + "params": [ { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "The ID of the Bucket", + "length": 255, + "name": "id", + "related": "createBucket,listBuckets", + "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 project name of the vlan range", - "name": "project", + "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" }, { "description": "Adds API permissions to a project role", @@ -54399,185 +54439,145 @@ "name": "createProjectRolePermission", "params": [ { - "description": "ID of the project role", + "description": "The description of the role permission", "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" }, { - "description": "ID of project where project role permission is to be created", + "description": "The rule permission, allow or deny. Default: deny.", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "permission", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The rule permission, allow or deny. Default: deny.", + "description": "The API name or wildcard rule such as list*", "length": 255, - "name": "permission", + "name": "rule", "required": true, "type": "string" }, { - "description": "The description of the role permission", + "description": "ID of project where project role permission is to be created", "length": 255, - "name": "description", - "required": false, - "type": "string" + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" }, { - "description": "The API name or wildcard rule such as list*", + "description": "ID of the project role", "length": 255, - "name": "rule", + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listProjectRolePermissions", "response": [ - { - "description": "the ID of the project role permission", - "name": "id", - "type": "string" - }, - { - "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 permission type of the api name or wildcard rule, allow/deny", "name": "permission", "type": "string" }, + {}, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" }, + {}, { "description": "the ID of the project", "name": "projectid", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", - "type": "string" - } - ], - "since": "4.15.0" - }, - { - "description": "Deletes an empty Bucket.", - "isasync": false, - "name": "deleteBucket", - "params": [ - { - "description": "The ID of the Bucket", - "length": 255, + "description": "the ID of the project role permission", "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the description of the role permission", + "name": "description", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - {} + } ], - "since": "4.19.0" + "since": "4.15.0" }, { "description": "Create a console endpoint to connect to a VM console", "isasync": false, "name": "createConsoleEndpoint", "params": [ - { - "description": "ID of the VM", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, { "description": "(optional) extra security token, valid when the extra validation is enabled", "length": 255, "name": "token", "required": false, "type": "string" + }, + { + "description": "ID of the VM", + "length": 255, + "name": "virtualmachineid", + "related": "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": "", "response": [ - { - "description": "the console url", - "name": "url", - "type": "string" - }, { "description": "the console websocket options", "name": "websocket", "type": "consoleendpointwebsocketresponse" }, + {}, { "description": "true if the console endpoint is generated properly", "name": "success", "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the console 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": "details in case of an error", "name": "details", @@ -54591,21 +54591,6 @@ "isasync": false, "name": "updateProjectRolePermission", "params": [ - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", - "required": true, - "type": "uuid" - }, - { - "description": "Rule permission, can be: allow or deny", - "length": 255, - "name": "permission", - "required": false, - "type": "string" - }, { "description": "Project Role permission rule id", "length": 255, @@ -54623,32 +54608,47 @@ "type": "uuid" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "Rule permission, can be: allow or deny", "length": 255, - "name": "ruleorder", - "related": "listProjectRolePermissions", + "name": "permission", "required": false, - "type": "list" - } - ], - "response": [ + "type": "string" + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": true, + "type": "uuid" }, + { + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "length": 255, + "name": "ruleorder", + "related": "listProjectRolePermissions", + "required": false, + "type": "list" + } + ], + "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", @@ -54663,11 +54663,11 @@ "name": "addUserToProject", "params": [ { - "description": "ID of the project to add the user to", + "description": "ID of the project role", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", - "required": true, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, "type": "uuid" }, { @@ -54678,50 +54678,50 @@ "type": "string" }, { - "description": "ID of the project role", + "description": "ID of the project to add the user to", "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", - "required": false, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, "type": "uuid" }, { - "description": "Project role type to be assigned to the user - Admin/Regular", + "description": "email ID of user to which invitation to the project is going to be sent", "length": 255, - "name": "roletype", + "name": "email", "required": false, "type": "string" }, { - "description": "email ID of user to which invitation to the project is going to be sent", + "description": "Project role type to be assigned to the user - Admin/Regular", "length": 255, - "name": "email", + "name": "roletype", "required": false, "type": "string" } ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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", + "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.14" @@ -54741,18 +54741,6 @@ } ], "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", @@ -54762,6 +54750,18 @@ "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" @@ -54772,43 +54772,43 @@ "name": "deleteTungstenFabricFirewallPolicy", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "firewallpolicyuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "the ID of zone", "length": 255, - "name": "firewallpolicyuuid", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "string" + "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" }, {}, {}, { - "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" } ] }, @@ -54821,105 +54821,42 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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 pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "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", + "description": "device type of the root volume", + "name": "rootdevicetype", "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 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": "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": "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" - } - ], - "type": "set" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { "description": "the user's ID who deployed the virtual machine", @@ -54927,33 +54864,43 @@ "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the project id of the vm", + "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 availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 memory used by the VM in KiB", - "name": "memorykbs", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { @@ -54962,176 +54909,172 @@ "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": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the project name of the vm", + "name": "project", "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "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": "path of the Domain the affinity group belongs to", + "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { "description": "the user's name who deployed the virtual machine", @@ -55139,247 +55082,178 @@ "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "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", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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 project name of the vm", - "name": "project", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "User VM type", + "name": "vmtype", "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": "device ID of the root volume", - "name": "rootdeviceid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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 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 traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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": "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 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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "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", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the description of the security group", + "name": "description", "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "the 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": "customer associated with the tag", + "name": "customer", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "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": "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" - } - ], - "type": "set" - }, - { - "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "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 project name of the group", - "name": "project", + "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 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 ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -55388,18 +55262,18 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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" }, { @@ -55408,48 +55282,38 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "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" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "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": "security group name", "name": "securitygroupname", @@ -55461,102 +55325,85 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "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": "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" } ], "type": "set" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the domain name of the security group", + "name": "domain", + "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 list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "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 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 domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "tag value", - "name": "value", - "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", - "response": [ + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -55564,13 +55411,13 @@ "name": "tags", "response": [ { - "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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -55579,18 +55426,18 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "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": "tag value", + "name": "value", "type": "string" }, { @@ -55599,13 +55446,13 @@ "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": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -55622,301 +55469,454 @@ "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": "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", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "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" } ], "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": "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 number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "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" } ], "type": "set" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the 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 type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "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": "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": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "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 name of the affinity group", + "name": "name", + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "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 type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the ID of the virtual machine", + "name": "id", + "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "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": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "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 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 virtual machine", - "name": "account", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "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", + "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": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "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": "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": "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": "true if nic is default, false otherwise", + "name": "macaddress", + "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 ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "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 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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "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" + }, + { + "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 cidr of IPv6 network", + "name": "ip6cidr", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "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 if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, - {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "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": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "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": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" } ] @@ -55936,27 +55936,27 @@ } ], "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": "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.17.0" @@ -55966,6 +55966,13 @@ "isasync": true, "name": "updateBgpPeer", "params": [ + { + "description": "The IPv4 address of the Bgp Peer.", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, { "description": "The IPv6 address of the Bgp Peer.", "length": 255, @@ -55974,11 +55981,11 @@ "type": "string" }, { - "description": "The IPv4 address of the Bgp Peer.", + "description": "BGP peer details in key/value pairs.", "length": 255, - "name": "ipaddress", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { "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)", @@ -55987,6 +55994,13 @@ "required": false, "type": "boolean" }, + { + "description": "The password of the Bgp Peer.", + "length": 255, + "name": "password", + "required": false, + "type": "string" + }, { "description": "Id of the Bgp Peer", "length": 255, @@ -56001,48 +56015,20 @@ "name": "asnumber", "required": false, "type": "long" - }, - { - "description": "The password of the Bgp Peer.", - "length": 255, - "name": "password", - "required": false, - "type": "string" - }, - { - "description": "BGP peer details in key/value pairs.", - "length": 255, - "name": "details", - "required": false, - "type": "map" } ], "related": "createBgpPeer,listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "response": [ - { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the project name of the bgp peer", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the bgp peer", - "name": "domain", - "type": "string" - }, { "description": "date when this bgp peer was created.", "name": "created", "type": "date" }, + {}, { - "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 domain ID of the bgp peer", @@ -56050,23 +56036,23 @@ "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "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": "password of bgp peer", - "name": "password", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { @@ -56074,31 +56060,45 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "IPv6 address of bgp peer", - "name": "ip6address", - "type": "string" - }, { "description": "id of zone to which the bgp peer belongs to.", "name": "zoneid", "type": "string" }, - {}, { "description": "the account of the bgp peer", "name": "account", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "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": "the project name of the bgp peer", + "name": "project", + "type": "string" + }, + {}, + { + "description": "password of bgp peer", + "name": "password", "type": "string" } ], @@ -56110,24 +56110,9 @@ "name": "updateTungstenFabricLBHealthMonitor", "params": [ { - "description": "the ID of lb rule", - "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", - "required": true, - "type": "uuid" - }, - { - "description": "loadbalancer health monitor expected code", - "length": 255, - "name": "expectedcode", - "required": false, - "type": "string" - }, - { - "description": "loadbalancer health monitor url path", + "description": "loadbalancer health monitor http method", "length": 255, - "name": "urlpath", + "name": "httpmethodtype", "required": false, "type": "string" }, @@ -56139,11 +56124,12 @@ "type": "integer" }, { - "description": "loadbalancer health monitor http method", + "description": "the ID of lb rule", "length": 255, - "name": "httpmethodtype", - "required": false, - "type": "string" + "name": "lbruleid", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule", + "required": true, + "type": "uuid" }, { "description": "loadbalancer health monitor retry", @@ -56159,45 +56145,53 @@ "required": true, "type": "integer" }, + { + "description": "loadbalancer health monitor url path", + "length": 255, + "name": "urlpath", + "required": false, + "type": "string" + }, { "description": "loadbalancer health monitor type", "length": 255, "name": "type", "required": true, "type": "string" + }, + { + "description": "loadbalancer health monitor expected code", + "length": 255, + "name": "expectedcode", + "required": false, + "type": "string" } ], "related": "", "response": [ - { - "description": "the health monitor expected code", - "name": "expectedcode", - "type": "string" - }, - {}, { "description": "the health monitor interval", "name": "interval", "type": "int" }, { - "description": "the health monitor retry", - "name": "retry", - "type": "int" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the health monitor UUID", - "name": "uuid", + "description": "the health monitor url path", + "name": "urlpath", "type": "string" }, { - "description": "the health monitor type", - "name": "type", + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the health monitor expected code", + "name": "expectedcode", "type": "string" }, { @@ -56206,8 +56200,8 @@ "type": "int" }, { - "description": "the health monitor http method", - "name": "httpmethod", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -56216,16 +56210,6 @@ "name": "lbruleid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the health monitor url path", - "name": "urlpath", - "type": "string" - }, { "description": "the health monitor ID", "name": "id", @@ -56237,9 +56221,25 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the health monitor type", + "name": "type", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the health monitor retry", + "name": "retry", + "type": "int" + }, + { + "description": "the health monitor http method", + "name": "httpmethod", + "type": "string" } ] }, @@ -56252,12 +56252,14 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], "response": [ + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -56273,8 +56275,6 @@ "name": "jobid", "type": "string" }, - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -56288,11 +56288,11 @@ "name": "updateProjectInvitation", "params": [ { - "description": "if true, accept the invitation, decline if false. True by default", + "description": "account that is joining the project", "length": 255, - "name": "accept", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "User UUID, required for adding account from external provisioning system", @@ -56309,13 +56309,6 @@ "required": false, "type": "string" }, - { - "description": "account that is joining the project", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "id of the project to join", "length": 255, @@ -56323,30 +56316,37 @@ "related": "activateProject,createProject,suspendProject", "required": true, "type": "uuid" + }, + { + "description": "if true, accept the invitation, decline if false. True by default", + "length": 255, + "name": "accept", + "required": false, + "type": "boolean" } ], "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": "3.0.0" @@ -56368,60 +56368,116 @@ "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "response": [ { - "description": "display name of the os on volume", - "name": "osdisplayname", - "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 account associated with the snapshot", - "name": "account", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, - {}, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "the list of resource tags associated", + "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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "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", @@ -56429,33 +56485,38 @@ "type": "long" }, { - "description": "the project name of the snapshot", - "name": "project", + "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": "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": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { @@ -56464,18 +56525,18 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project name of the snapshot", + "name": "project", + "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -56484,40 +56545,34 @@ "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "volumename", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "name of the snapshot", - "name": "name", - "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", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, - {}, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { "description": "ID of the snapshot", @@ -56525,77 +56580,22 @@ "type": "string" }, { - "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 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" - }, - { - "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": "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": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, + {}, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" - } + }, + {} ] }, { @@ -56603,13 +56603,6 @@ "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 ID of the condition.", "length": 255, @@ -56624,9 +56617,26 @@ "name": "relationaloperator", "required": true, "type": "string" + }, + { + "description": "Value for which the Counter will be evaluated with the Operator selected.", + "length": 255, + "name": "threshold", + "required": true, + "type": "long" } ], "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" + }, {}, {}, { @@ -56638,16 +56648,6 @@ "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.0" @@ -56657,6 +56657,13 @@ "isasync": false, "name": "listRegions", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "List Region by region name.", "length": 255, @@ -56671,13 +56678,6 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -56695,6 +56695,11 @@ ], "related": "addRegion,updateRegion", "response": [ + { + "description": "the end point of the region", + "name": "endpoint", + "type": "string" + }, { "description": "true if GSLB service is enabled in the region, false otherwise", "name": "gslbserviceenabled", @@ -56706,31 +56711,26 @@ "type": "integer" }, { - "description": "the name of the region", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the end point of the region", - "name": "endpoint", + "description": "the name of the region", + "name": "name", "type": "string" }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" - }, { "description": "the ID of the region", "name": "id", "type": "integer" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" } ] }, @@ -56748,7 +56748,15 @@ "type": "boolean" }, { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "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", @@ -56760,39 +56768,41 @@ "description": "destination Host ID to migrate VM to", "length": 255, "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" - }, - { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": true, - "type": "uuid" } ], "related": "startSystemVm,changeServiceForSystemVm", "response": [ + { + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" + }, { "description": "the Pod ID for the system VM", "name": "podid", "type": "string" }, { - "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": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { @@ -56801,54 +56811,55 @@ "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "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", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, - {}, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, + {}, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "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 host ID for the system VM", + "name": "hostid", + "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { @@ -56857,69 +56868,68 @@ "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the Pod name for the system VM", + "name": "podname", + "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 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 link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "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 state of the system VM", + "name": "state", "type": "string" }, { @@ -56928,63 +56938,53 @@ "type": "list" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the ID of the system VM", - "name": "id", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" } ] @@ -57002,61 +57002,60 @@ "type": "string" }, { - "description": "Source of the counter.", + "description": "ID of the Counter.", "length": 255, - "name": "source", + "name": "id", + "related": "createCounter,listCounters", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "ID of the Counter.", + "description": "", "length": 255, - "name": "id", - "related": "createCounter,listCounters", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Network provider of the counter.", + "description": "Source of the counter.", "length": 255, - "name": "provider", + "name": "source", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "Network provider of the counter.", "length": 255, - "name": "page", + "name": "provider", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "string" } ], "related": "createCounter", "response": [ - {}, { - "description": "Provider of the counter.", - "name": "provider", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Provider of the counter.", + "name": "provider", "type": "string" }, { @@ -57064,30 +57063,31 @@ "name": "source", "type": "string" }, + {}, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "zone id of counter", "name": "zoneid", "type": "string" }, { - "description": "the id of the Counter", - "name": "id", + "description": "Name of the counter.", + "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 counter.", - "name": "name", + "description": "the id of the Counter", + "name": "id", "type": "string" } ] @@ -57098,23 +57098,33 @@ "name": "configureInternalLoadBalancerElement", "params": [ { - "description": "the ID of the internal lb provider", + "description": "Enables/Disables the Internal Load Balancer element", "length": 255, - "name": "id", - "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", + "name": "enabled", "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "Enables/Disables the Internal Load Balancer element", + "description": "the ID of the internal lb provider", "length": 255, - "name": "enabled", + "name": "id", + "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", "required": true, - "type": "boolean" + "type": "uuid" } ], "related": "listInternalLoadBalancerElements", "response": [ + { + "description": "the id of the internal load balancer element", + "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", @@ -57126,21 +57136,11 @@ "name": "nspid", "type": "string" }, + {}, { "description": "Enabled/Disabled the element", "name": "enabled", "type": "boolean" - }, - {}, - { - "description": "the id of the internal load balancer element", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.2.0" @@ -57151,18 +57151,12 @@ "name": "removeTungstenFabricTag", "params": [ { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": false, - "type": "string" - }, - { - "description": "the uuid of vms", + "description": "the ID of zone", "length": 255, - "name": "vmuuid", - "required": false, - "type": "list" + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { "description": "the uuid of Tungsten-Fabric policy", @@ -57172,19 +57166,18 @@ "type": "string" }, { - "description": "the uuid of networks", + "description": "the uuid of vms", "length": 255, - "name": "networkuuid", + "name": "vmuuid", "required": false, "type": "list" }, { - "description": "the ID of zone", + "description": "the uuid of nics", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "name": "nicuuid", + "required": false, + "type": "list" }, { "description": "the uuid of Tungsten-Fabric tag", @@ -57194,34 +57187,42 @@ "type": "string" }, { - "description": "the uuid of nics", + "description": "the uuid of networks", "length": 255, - "name": "nicuuid", + "name": "networkuuid", "required": false, "type": "list" + }, + { + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" } ], "related": "createTungstenFabricTag,listTungstenFabricTag,applyTungstenFabricTag", "response": [ { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, + {}, { - "description": "list Tungsten-Fabric vm", - "name": "vm", + "description": "list Tungsten-Fabric network", + "name": "network", "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, { "description": "list Tungsten-Fabric policy", @@ -57229,30 +57230,29 @@ "type": "list" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "Tungsten-Fabric tag name", + "name": "name", + "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" } ] @@ -57263,78 +57263,78 @@ "name": "listVirtualRouterElements", "params": [ { - "description": "list virtual router elements by id", + "description": "", "length": 255, - "name": "id", - "related": "configureVirtualRouterElement,listVirtualRouterElements", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list virtual router elements by network service provider id", + "description": "list network offerings by enabled state", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "name": "enabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "list virtual router elements by network service provider id", "length": 255, - "name": "pagesize", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "list virtual router elements by id", "length": 255, - "name": "page", + "name": "id", + "related": "configureVirtualRouterElement,listVirtualRouterElements", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list network offerings by enabled state", + "description": "List by keyword", "length": 255, - "name": "enabled", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "configureVirtualRouterElement", "response": [ { - "description": "the account associated with the provider", - "name": "account", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { - "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" }, - {}, { - "description": "the id of the router", - "name": "id", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, + {}, { "description": "the domain associated with the provider", "name": "domain", @@ -57342,29 +57342,29 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account associated with the provider", + "name": "account", + "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": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "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" } ] }, @@ -57383,28 +57383,28 @@ } ], "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": "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" }, @@ -57414,40 +57414,32 @@ "name": "createRoutingFirewallRule", "params": [ { - "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 of the VM the firewall rule will be created for", + "description": "type of the ICMP message being sent", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "cidrlist", + "name": "fordisplay", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "type of the ICMP message being sent", + "description": "the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "icmptype", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ending port of firewall rule", + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "endport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { "description": "the starting port of firewall rule", @@ -57457,11 +57449,12 @@ "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "The network of the VM the firewall rule will be created for", "length": 255, - "name": "fordisplay", - "required": false, - "type": "boolean" + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { "description": "error code for this ICMP message", @@ -57471,11 +57464,11 @@ "type": "integer" }, { - "description": "the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "the ending port of firewall rule", "length": 255, - "name": "traffictype", + "name": "endport", "required": false, - "type": "string" + "type": "integer" }, { "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", @@ -57483,100 +57476,50 @@ "name": "destcidrlist", "required": false, "type": "list" - } - ], - "related": "updateIpv6FirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", - "response": [ - { - "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", + "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" - }, + } + ], + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules,updateIpv6FirewallRule", + "response": [ { "description": "the starting port of port forwarding rule's private port range", "name": "privateport", "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "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 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "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 ending port of port forwarding rule's private port range", - "name": "publicendport", - "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 public port range", "name": "publicport", "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 id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { @@ -57584,62 +57527,119 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "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": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "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": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "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", + "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 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": "privateendport", + "type": "string" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + {}, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" } ], "since": "4.20.0" @@ -57650,32 +57650,32 @@ "name": "linkAccountToLdap", "params": [ { - "description": "The id of the domain that is to contain the linked account.", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "ldapdomain", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "name of the group or OU in LDAP", + "description": "The id of the domain that is to contain the linked account.", "length": 255, - "name": "ldapdomain", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "description": "domain admin username in LDAP ", "length": 255, - "name": "accounttype", + "name": "admin", "required": false, - "type": "integer" + "type": "string" }, { - "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "description": "name of the account, it will be created if it does not exist", "length": 255, - "name": "type", - "required": false, + "name": "account", + "required": true, "type": "string" }, { @@ -57688,52 +57688,51 @@ "type": "uuid" }, { - "description": "domain admin username in LDAP ", + "description": "type of the ldap name. GROUP or OU, defaults to GROUP", "length": 255, - "name": "admin", + "name": "type", "required": false, "type": "string" }, { - "description": "name of the account, it will be created if it does not exist", + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", "length": 255, - "name": "account", - "required": true, - "type": "string" + "name": "accounttype", + "required": false, + "type": "integer" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "Type of the account to auto import", "name": "accounttype", "type": "int" }, {}, + { + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", + "type": "string" + }, { "description": "id of the Domain which is linked to LDAP", "name": "domainid", "type": "string" }, { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", + "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": "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": "type of the name in LDAP which is linked to the domain", + "name": "type", "type": "string" }, { @@ -57742,10 +57741,11 @@ "type": "integer" }, { - "description": "Domain Admin accountId that is created", - "name": "accountid", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", "type": "string" - } + }, + {} ], "since": "4.11.0" }, @@ -57758,43 +57758,44 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ + { + "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 out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { "description": "the out-of-band management interface port", @@ -57802,35 +57803,34 @@ "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 action (if issued)", - "name": "action", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, - {}, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management interface address", + "name": "address", "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" } ], "since": "4.9.0" @@ -57844,22 +57844,27 @@ "description": "host ID", "length": 255, "name": "id", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ { - "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 CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { "description": "the cpu average load on the host", @@ -57867,33 +57872,38 @@ "type": "double" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the host version", - "name": "version", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { @@ -57902,129 +57912,64 @@ "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "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": "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": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "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": "the Zone name of the host", - "name": "zonename", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, - {}, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "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": "comma-separated list of tags for the host", @@ -58032,23 +57977,13 @@ "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { @@ -58057,8 +57992,13 @@ "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { @@ -58067,45 +58007,110 @@ "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, + {}, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, - {}, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "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 Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + {}, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", "type": "integer" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { "description": "the date and time the host was created", @@ -58113,9 +58118,19 @@ "type": "date" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "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", @@ -58123,19 +58138,24 @@ "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { "description": "true if the host supports encryption", @@ -58143,73 +58163,68 @@ "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", - "type": "boolean" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the ID of the host", - "name": "id", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "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": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "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 Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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 outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "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 host", - "name": "arch", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { @@ -58218,29 +58233,14 @@ "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "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 last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" } ], "since": "4.16.0.0" @@ -58250,13 +58250,6 @@ "isasync": false, "name": "releaseASNumber", "params": [ - { - "description": "the AS Number to be released", - "length": 255, - "name": "asnumber", - "required": true, - "type": "long" - }, { "description": "the zone ID", "length": 255, @@ -58264,31 +58257,38 @@ "related": "createZone,listZones", "required": true, "type": "uuid" + }, + { + "description": "the AS Number to be released", + "length": 255, + "name": "asnumber", + "required": true, + "type": "long" } ], "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": "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" }, @@ -58312,13 +58312,6 @@ "required": true, "type": "string" }, - { - "description": "an optional account for the security group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "Create security group for project", "length": 255, @@ -58333,63 +58326,138 @@ "name": "description", "required": false, "type": "string" + }, + { + "description": "an optional account for the security group. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "updateSecurityGroup", "response": [ { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "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", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "account owning the security group rule", + "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": "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 domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "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": "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 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", + "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 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", @@ -58401,13 +58469,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -58416,18 +58479,18 @@ "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 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 project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -58435,11 +58498,6 @@ "name": "projectid", "type": "string" }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "tag key name", "name": "key", @@ -58449,9 +58507,34 @@ "description": "tag value", "name": "value", "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" } ], "type": "set" + }, + { + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" @@ -58461,58 +58544,53 @@ "name": "id", "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 ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "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 code for the ICMP message response", - "name": "icmpcode", + "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": "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", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -58521,8 +58599,13 @@ "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", "type": "string" }, { @@ -58531,13 +58614,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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" }, { @@ -58546,60 +58629,55 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "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 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": "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" } ], "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 domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the current status of the latest async job acting on this object", @@ -58607,92 +58685,14 @@ "type": "integer" }, { - "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 description of the security group", "name": "description", "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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "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 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": "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" - } - ], - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" } ] }, @@ -58712,30 +58712,19 @@ ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the account the network is available for", "name": "account", "type": "string" }, - { - "description": "the project the network is available for", - "name": "project", - "type": "string" - }, { "description": "the ID of project the network is available for", "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain to which the network belongs", + "name": "domainid", "type": "string" }, { @@ -58744,13 +58733,18 @@ "type": "string" }, { - "description": "the ID of the domain to which the network belongs", - "name": "domainid", + "description": "the ID of account the network is available for", + "name": "accountid", "type": "string" }, { - "description": "the ID of account the network is available for", - "name": "accountid", + "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" }, { @@ -58758,7 +58752,13 @@ "name": "domain", "type": "string" }, - {} + {}, + {}, + { + "description": "the project the network is available for", + "name": "project", + "type": "string" + } ], "since": "4.17.0" }, @@ -58768,17 +58768,10 @@ "name": "listVpnGateways", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "id of vpc", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, @@ -58791,30 +58784,31 @@ "type": "uuid" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "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": "page", + "name": "listall", "required": false, - "type": "integer" + "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, @@ -58834,6 +58828,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -58842,34 +58843,23 @@ "type": "string" }, { - "description": "id of vpc", + "description": "", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createVpnGateway,updateVpnGateway", "response": [ - { - "description": "the vpc name of this gateway", - "name": "vpcname", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the public IP address", - "name": "publicip", + "description": "the project name", + "name": "project", "type": "string" }, { @@ -58877,53 +58867,63 @@ "name": "domainpath", "type": "string" }, + {}, { - "description": "the vpc id of this gateway", - "name": "vpcid", - "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": "the project id", "name": "projectid", "type": "string" }, + { + "description": "the owner", + "name": "account", + "type": "string" + }, { "description": "the vpn gateway ID", "name": "id", "type": "string" }, + { + "description": "the public IP address", + "name": "publicip", + "type": "string" + }, { "description": "the domain name of the owner", "name": "domain", "type": "string" }, - {}, { - "description": "the project name", - "name": "project", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the vpc id of this gateway", + "name": "vpcid", "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 owner", + "name": "domainid", + "type": "string" }, { "description": "is vpn gateway for display to the regular user", "name": "fordisplay", "type": "boolean" - }, - { - "description": "the owner", - "name": "account", - "type": "string" - }, - {} + } ] }, { @@ -58956,11 +58956,18 @@ } ], "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", @@ -58970,13 +58977,6 @@ "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" @@ -58990,34 +58990,34 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "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": "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" - } + {} ] }, { @@ -59026,10 +59026,10 @@ "name": "createVpnConnection", "params": [ { - "description": "id of the vpn gateway", + "description": "id of the customer gateway", "length": 255, - "name": "s2svpngatewayid", - "related": "createVpnGateway,updateVpnGateway", + "name": "s2scustomergatewayid", + "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "required": true, "type": "uuid" }, @@ -59041,87 +59041,98 @@ "since": "4.4", "type": "boolean" }, + { + "description": "id of the vpn gateway", + "length": 255, + "name": "s2svpngatewayid", + "related": "createVpnGateway,updateVpnGateway", + "required": true, + "type": "uuid" + }, { "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" } ], "related": "updateVpnConnection", "response": [ { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, { "description": "State of vpn connection", - "name": "state", - "type": "string" + "name": "passive", + "type": "boolean" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "is connection for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" }, + {}, { - "description": "the public IP address", - "name": "publicip", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { @@ -59130,23 +59141,28 @@ "type": "long" }, { - "description": "the project name", - "name": "project", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "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 domain path of the owner", - "name": "domainpath", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "the owner", + "name": "account", "type": "string" }, { @@ -59155,14 +59171,14 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "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", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { "description": "the current status of the latest async job acting on this object", @@ -59170,35 +59186,19 @@ "type": "integer" }, { - "description": "the connection ID", - "name": "id", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, + {}, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" - }, - { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, - {}, - {}, - { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" } ] @@ -59208,13 +59208,6 @@ "isasync": false, "name": "listBrocadeVcsDeviceNetworks", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "brocade vcs switch ID", "length": 255, @@ -59224,233 +59217,113 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "response": [ { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" - }, - { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" - }, - { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "The external id of the network", - "name": "externalid", - "type": "string" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "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": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, { "description": "related to what other network configuration", "name": "related", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, - { - "description": "the list of resource tags associated with network", - "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": "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": "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": "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the project name of the address", + "name": "project", "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", + "type": "boolean" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "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": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { "description": "the first IPv4 DNS for the network", @@ -59458,13 +59331,8 @@ "type": "string" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { @@ -59473,14 +59341,14 @@ "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the name of the Network associated with this private gateway", @@ -59488,159 +59356,108 @@ "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" - }, - { - "description": "the type of the network", - "name": "type", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "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": "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": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, - {}, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "The external id of the network", + "name": "externalid", + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "VPC the network belongs to", + "name": "vpcid", + "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": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "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" }, { @@ -59648,6 +59465,11 @@ "name": "associatednetworkid", "type": "string" }, + { + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" + }, { "description": "the list of services", "name": "service", @@ -59674,34 +59496,39 @@ ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "state of the network provider", + "name": "state", + "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "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 destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { "description": "the provider name", @@ -59709,65 +59536,238 @@ "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 service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, + { + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, {}, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "state of the network", + "name": "state", + "type": "string" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + {}, + { + "description": "the list of resource tags associated with network", + "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": "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": "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 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 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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" } ] @@ -59778,25 +59778,19 @@ "name": "listWebhookDeliveries", "params": [ { - "description": "The event type of the Webhook delivery", - "length": 255, - "name": "eventtype", - "required": false, - "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.", + "description": "The ID of the Webhook", "length": 255, - "name": "startdate", + "name": "webhookid", + "related": "createWebhook,listWebhookDeliveries", "required": false, - "type": "date" + "type": "uuid" }, { - "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.", + "description": "The event type of the Webhook delivery", "length": 255, - "name": "enddate", + "name": "eventtype", "required": false, - "type": "date" + "type": "string" }, { "description": "", @@ -59806,13 +59800,20 @@ "type": "integer" }, { - "description": "The ID of the Webhook", + "description": "The ID of the management server", "length": 255, - "name": "webhookid", - "related": "createWebhook,listWebhookDeliveries", + "name": "managementserverid", + "related": "listManagementServers", "required": false, "type": "uuid" }, + { + "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": "", "length": 255, @@ -59821,59 +59822,48 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "The ID of the Webhook delivery", "length": 255, - "name": "keyword", + "name": "id", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The ID of the management server", + "description": "List by keyword", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The ID of the Webhook delivery", + "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": "id", - "related": "", + "name": "enddate", "required": false, - "type": "uuid" + "type": "date" } ], "related": "createWebhook", "response": [ { - "description": "The account associated with the Webhook", - "name": "account", - "type": "string" - }, - { - "description": "The ID of the Webhook", - "name": "id", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" - }, - { - "description": "The name of the domain in which the Webhook exists", - "name": "domain", - "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", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { @@ -59881,26 +59871,32 @@ "name": "scope", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, { - "description": "The name of the Webhook", - "name": "name", + "description": "The ID of the Webhook", + "name": "id", + "type": "string" + }, + { + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, + {}, + {}, { "description": "The state of the Webhook", "name": "state", "type": "string" }, { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" + "description": "The description of the Webhook", + "name": "description", + "type": "string" }, { "description": "The ID of the domain in which the Webhook exists", @@ -59908,19 +59904,23 @@ "type": "string" }, { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", - "type": "string" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "The account associated with the Webhook", + "name": "account", + "type": "string" + }, + { + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { @@ -59929,8 +59929,8 @@ "type": "string" }, { - "description": "The description of the Webhook", - "name": "description", + "description": "The name of the Webhook", + "name": "name", "type": "string" } ], @@ -59960,7 +59960,7 @@ "description": "the ID of the host to update", "length": 255, "name": "hostid", - "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } @@ -59968,29 +59968,31 @@ "related": "listDedicatedHosts", "response": [ { - "description": "the Account ID of the host", - "name": "accountid", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 ID of the dedicated resource", "name": "id", "type": "string" }, + {}, { - "description": "the name of the host", - "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 host", @@ -59998,17 +60000,15 @@ "type": "string" }, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "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" - }, - {}, - {} + } ] }, { @@ -60017,33 +60017,33 @@ "name": "addGloboDnsHost", "params": [ { - "description": "Username for GloboDNS", + "description": "Password for GloboDNS", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "GloboDNS url", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "url", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "GloboDNS url", + "description": "Username for GloboDNS", "length": 255, - "name": "url", + "name": "username", "required": true, "type": "string" }, { - "description": "Password for GloboDNS", + "description": "the Physical Network ID", "length": 255, - "name": "password", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ @@ -60052,23 +60052,23 @@ "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": "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.5.0" }, @@ -60079,7 +60079,11 @@ "params": [], "related": "", "response": [ - {}, + { + "description": "Response description", + "name": "description", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -60090,11 +60094,7 @@ "name": "jobid", "type": "string" }, - { - "description": "Response description", - "name": "description", - "type": "string" - }, + {}, {} ] }, @@ -60111,11 +60111,11 @@ "type": "map" }, { - "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). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "length": 255, - "name": "type", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { "description": "The description of the role", @@ -60124,13 +60124,6 @@ "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).", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, { "description": "Creates a role with this unique name", "length": 255, @@ -60144,6 +60137,13 @@ "name": "forced", "required": false, "type": "boolean" + }, + { + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "length": 255, + "name": "type", + "required": false, + "type": "string" } ], "related": "createRole,listRoles,updateRole", @@ -60154,47 +60154,47 @@ "type": "string" }, { - "description": "the state of the role", - "name": "state", + "description": "the description of the role", + "name": "description", "type": "string" }, { - "description": "the name of the role", - "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": "the ID of the role", - "name": "id", + "description": "the state of the role", + "name": "state", "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", + "description": "true if role 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": "the type of the role", "name": "type", "type": "string" }, + {}, { - "description": "the description of the role", - "name": "description", + "description": "the ID of the role", + "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 role", + "name": "name", + "type": "string" }, - { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" - } + {} ], "since": "4.15.0" }, @@ -60204,45 +60204,45 @@ "name": "quotaEmailTemplateUpdate", "params": [ { - "description": "The quota email template body, max: 500k characters", - "length": 512000, - "name": "templatebody", + "description": "Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", + "length": 255, + "name": "templatetype", "required": true, "type": "string" }, { - "description": "The locale of the email text", - "length": 255, - "name": "locale", - "required": false, + "description": "The quota email template subject, max: 77 characters", + "length": 77, + "name": "templatesubject", + "required": true, "type": "string" }, { - "description": "Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", + "description": "The locale of the email text", "length": 255, - "name": "templatetype", - "required": true, + "name": "locale", + "required": false, "type": "string" }, { - "description": "The quota email template subject, max: 77 characters", - "length": 77, - "name": "templatesubject", + "description": "The quota email template body, max: 500k characters", + "length": 512000, + "name": "templatebody", "required": true, "type": "string" } ], "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { @@ -60251,9 +60251,9 @@ "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.7.0" @@ -60280,16 +60280,6 @@ } ], "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", @@ -60301,7 +60291,17 @@ "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" }, @@ -60310,20 +60310,6 @@ "isasync": false, "name": "listNetworkServiceProviders", "params": [ - { - "description": "list providers by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -60339,7 +60325,21 @@ "type": "string" }, { - "description": "List by keyword", + "description": "list providers by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", "length": 255, "name": "keyword", "required": false, @@ -60357,33 +60357,35 @@ "related": "addNetworkServiceProvider,listTrafficTypes", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "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": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -60391,18 +60393,16 @@ "name": "state", "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": "the provider name", + "name": "name", + "type": "string" + } ], "since": "3.0.0" }, @@ -60428,27 +60428,27 @@ } ], "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" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -60467,7 +60467,6 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -60478,6 +60477,7 @@ "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -60507,27 +60507,27 @@ } ], "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": "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" } ] }, @@ -60540,29 +60540,29 @@ "description": "The ID of the disk volume", "length": 255, "name": "id", - "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "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": "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", @@ -60575,13 +60575,6 @@ "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, @@ -60589,61 +60582,68 @@ "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", "required": true, "type": "uuid" + }, + { + "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": "listSecondaryStorageSelectors", "response": [ { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "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 removed.", - "name": "removed", + "description": "When the heuristic 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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "ID of the heuristic.", - "name": "id", + "description": "Description of the heuristic.", + "name": "description", "type": "string" }, { - "description": "Description of the heuristic.", - "name": "description", + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "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": "Name of the heuristic.", "name": "name", "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 removed.", + "name": "removed", + "type": "date" }, + {}, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "ID of the heuristic.", + "name": "id", + "type": "string" } ], "since": "4.19.0" @@ -60664,56 +60664,45 @@ ], "related": "createUser,disableUser,getUser,listUsers,lockUser", "response": [ - {}, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the name of the role", + "name": "rolename", "type": "string" }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - {}, { "description": "the account type of the user", "name": "accounttype", "type": "integer" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "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", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "the user name", + "name": "username", + "type": "string" + }, + {}, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { @@ -60722,28 +60711,28 @@ "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 state", - "name": "state", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user ID", + "name": "id", "type": "string" }, { @@ -60752,50 +60741,61 @@ "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "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": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "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 domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the timezone user was created in", + "name": "timezone", "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 user", + "name": "domain", + "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user email address", + "name": "email", "type": "string" - } + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + {} ] }, { @@ -60804,12 +60804,27 @@ "name": "quotaTariffCreate", "params": [ { - "description": "Integer value for the usage type of the resource.", + "description": "The effective start date on/after which the quota tariff is effective. Inform null to use the current 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 \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "usagetype", - "required": true, + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "Position in the execution sequence for tariffs of the same type", + "length": 255, + "name": "position", + "required": false, + "since": "4.20.0.0", "type": "integer" }, + { + "description": "Quota tariff's description.", + "length": 65535, + "name": "description", + "required": false, + "type": "string" + }, { "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied.", "length": 65535, @@ -60832,11 +60847,11 @@ "type": "string" }, { - "description": "Quota tariff's description.", - "length": 65535, - "name": "description", - "required": false, - "type": "string" + "description": "Integer value for the usage type of the resource.", + "length": 255, + "name": "usagetype", + "required": true, + "type": "integer" }, { "description": "The quota tariff value of the resource as per the default unit.", @@ -60844,35 +60859,25 @@ "name": "value", "required": true, "type": "double" - }, - { - "description": "Position in the execution sequence for tariffs of the same type", - "length": 255, - "name": "position", - "required": false, - "since": "4.20.0.0", - "type": "integer" - }, - { - "description": "The effective start date on/after which the quota tariff is effective. Inform null to use the current 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 \"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" } ], "related": "quotaTariffList", "response": [ + { + "description": "usageDiscriminator", + "name": "usageDiscriminator", + "type": "string" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "usageName", + "name": "usageName", "type": "string" }, { - "description": "usageType", - "name": "usageType", - "type": "int" + "description": "currency", + "name": "currency", + "type": "string" }, { "description": "the start date of the quota tariff", @@ -60880,19 +60885,19 @@ "type": "date" }, { - "description": "when the quota tariff was removed", - "name": "removed", - "type": "date" + "description": "usageType", + "name": "usageType", + "type": "int" }, { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" + "description": "the ID of the tariff", + "name": "id", + "type": "string" }, { - "description": "usageUnit", - "name": "usageUnit", - "type": "string" + "description": "position in the execution sequence for tariffs of the same type", + "name": "position", + "type": "integer" }, { "description": "name", @@ -60900,34 +60905,33 @@ "type": "string" }, { - "description": "description", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "usageDiscriminator", - "name": "usageDiscriminator", + "description": "usageUnit", + "name": "usageUnit", "type": "string" }, { - "description": "usage type description", - "name": "usageTypeDescription", + "description": "activation rule of the quota tariff", + "name": "activationRule", "type": "string" }, { - "description": "position in the execution sequence for tariffs of the same type", - "name": "position", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "usageName", - "name": "usageName", + "description": "description", + "name": "description", "type": "string" }, { - "description": "the ID of the tariff", - "name": "id", + "description": "usage type description", + "name": "usageTypeDescription", "type": "string" }, { @@ -60936,20 +60940,16 @@ "type": "bigdecimal" }, { - "description": "activation rule of the quota tariff", - "name": "activationRule", - "type": "string" + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" }, { - "description": "currency", - "name": "currency", - "type": "string" + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.18.0.0" }, @@ -60970,63 +60970,28 @@ "related": "activateProject,createProject", "response": [ { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "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 owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "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 primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "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 project", + "name": "vmlimit", "type": "string" }, { @@ -61035,48 +61000,33 @@ "type": "integer" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "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) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { @@ -61085,119 +61035,105 @@ "type": "integer" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, - { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" - }, - { - "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 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": "the project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, + {}, { "description": "the total number of cpu cores the project can own", "name": "cpulimit", "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 public ip addresses allocated for this project", - "name": "iptotal", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, { - "description": "the name of the project", - "name": "name", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { "description": "the list of resource tags associated with vm", @@ -61209,13 +61145,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -61229,28 +61165,28 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 project id the tag belongs to", - "name": "projectid", + "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" }, { @@ -61262,15 +61198,79 @@ "type": "list" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "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 state of the project", + "name": "state", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "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 volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" }, - {}, {}, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" } ], @@ -61283,42 +61283,42 @@ "params": [], "related": "", "response": [ - { - "description": "seconds left to reset counters", - "name": "expireAfter", - "type": "long" - }, - {}, - { - "description": "the account name of the api remaining count", - "name": "account", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the account uuid of the api remaining count", "name": "accountid", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "number of api already issued", "name": "apiIssued", "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", + "type": "string" }, { "description": "currently allowed number of apis", "name": "apiAllowed", "type": "int" }, + { + "description": "the account name of the api remaining count", + "name": "account", + "type": "string" + }, + { + "description": "seconds left to reset counters", + "name": "expireAfter", + "type": "long" + }, {} ] }, @@ -61337,18 +61337,11 @@ } ], "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", @@ -61358,7 +61351,14 @@ "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": "3.0.0" }, @@ -61375,12 +61375,11 @@ "type": "string" }, { - "description": "The Zone ID.", + "description": "The Username required to connect to resource.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "name": "username", + "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.", @@ -61397,23 +61396,25 @@ "type": "string" }, { - "description": "The Username required to connect to resource.", + "description": "The Zone ID.", "length": 255, - "name": "username", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, + {}, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -61422,22 +61423,21 @@ "type": "long" }, { - "description": "The VMware Datacenter name", - "name": "name", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" }, {}, - { - "description": "The VMware Datacenter ID", - "name": "id", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "The VMware Datacenter ID", + "name": "id", + "type": "string" + } ] }, { @@ -61446,25 +61446,33 @@ "name": "updateIpv6FirewallRule", "params": [ { - "description": "the ending port of Ipv6 firewall rule", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "endport", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "the ID of the ipv6 firewall rule", "length": 255, - "name": "startport", + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + }, + { + "description": "the ending port of Ipv6 firewall rule", + "length": 255, + "name": "endport", "required": false, "type": "integer" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "traffictype", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", @@ -61475,17 +61483,9 @@ "type": "boolean" }, { - "description": "the ID of the ipv6 firewall rule", - "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", - "required": true, - "type": "uuid" - }, - { - "description": "type of the ICMP message being sent", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "icmptype", + "name": "startport", "required": false, "type": "integer" }, @@ -61497,62 +61497,144 @@ "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, - "since": "4.4", - "type": "string" + "type": "integer" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "cidrlist", + "name": "traffictype", "required": false, - "type": "list" + "type": "string" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "protocol", + "name": "customid", "required": false, + "since": "4.4", "type": "string" } ], - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "response": [ + { + "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 starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + {}, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "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 ID of the port forwarding rule", + "name": "id", + "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 id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "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 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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -61560,6 +61642,11 @@ "name": "value", "type": "string" }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "customer associated with the tag", "name": "customer", @@ -61576,149 +61663,61 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Updates ISO permissions", + "isasync": false, + "name": "updateIsoPermissions", + "params": [ { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" + "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": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" }, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "permission operator (add, remove, reset)", + "length": 255, + "name": "op", + "required": false, "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "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 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 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 VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "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 vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - } - ] - }, - { - "description": "Updates ISO permissions", - "isasync": false, - "name": "updateIsoPermissions", - "params": [ - { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "projectids", - "related": "activateProject,createProject", - "required": false, - "type": "list" - }, - { - "description": "true for public template/iso, false for private templates/isos", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, - { - "description": "permission operator (add, remove, reset)", - "length": 255, - "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": "the template ID", "length": 255, "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "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": "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 featured template/iso, false otherwise", "length": 255, @@ -61727,26 +61726,21 @@ "type": "boolean" }, { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accounts", + "name": "projectids", + "related": "activateProject,createProject", "required": false, "type": "list" } ], "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", @@ -61756,7 +61750,13 @@ "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" + }, + {} ] }, { @@ -61774,13 +61774,11 @@ } ], "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", @@ -61791,6 +61789,8 @@ "name": "success", "type": "boolean" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -61814,25 +61814,25 @@ ], "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", + "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" } ] @@ -61843,18 +61843,19 @@ "name": "listASNRanges", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the zone ID", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -61864,27 +61865,42 @@ "type": "integer" }, { - "description": "the zone ID", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ + { + "description": "Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "Start AS Number", + "name": "startasn", + "type": "long" + }, { "description": "Created date", "name": "created", "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": "ID of the AS Number Range", "name": "id", @@ -61894,22 +61910,6 @@ "description": "End AS Number", "name": "endasn", "type": "long" - }, - {}, - { - "description": "Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Start AS Number", - "name": "startasn", - "type": "long" } ], "since": "4.20.0" @@ -61927,75 +61927,75 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric tag type", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "tagtype", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric tag type", + "description": "the ID of zone", "length": 255, - "name": "tagtype", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listTungstenFabricTag,applyTungstenFabricTag", "response": [ + {}, { - "description": "list Tungsten-Fabric policy", - "name": "policy", + "description": "list Tungsten-Fabric nic", + "name": "nic", "type": "list" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric tag name", + "name": "name", "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 provider zone name", + "name": "zonename", + "type": "string" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "list Tungsten-Fabric vm", "name": "vm", "type": "list" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "list Tungsten-Fabric network", - "name": "network", + "description": "list Tungsten-Fabric policy", + "name": "policy", "type": "list" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "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": "list Tungsten-Fabric network", + "name": "network", + "type": "list" + }, + {} ] }, { @@ -62011,19 +62011,19 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "Username to access the OpenDaylight API", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Username to access the OpenDaylight API", + "description": "the Physical Network ID", "length": 255, - "name": "username", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Credential to access the OpenDaylight API", @@ -62035,15 +62035,14 @@ ], "related": "deleteOpenDaylightController", "response": [ - {}, { - "description": "device id of the controller", - "name": "id", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, { @@ -62051,27 +62050,28 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the url of the controller api", + "name": "url", + "type": "string" + }, { "description": "the physical network to which this controller belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "the url of the controller api", - "name": "url", + "description": "device id of the controller", + "name": "id", "type": "string" }, - {}, { "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" - } + {}, + {} ] }, { @@ -62080,18 +62080,18 @@ "name": "createZone", "params": [ { - "description": "the second DNS for the Zone", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "dns2", + "name": "guestcidraddress", "required": false, "type": "string" }, { - "description": "the name of the Zone", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "localstorageenabled", + "required": false, + "type": "boolean" }, { "description": "the second DNS for IPv6 network in the Zone", @@ -62101,11 +62101,19 @@ "type": "string" }, { - "description": "the second internal DNS for the Zone", + "description": "true if the zone is an edge zone, false otherwise", "length": 255, - "name": "internaldns2", + "name": "isedge", "required": false, - "type": "string" + "since": "4.18.0", + "type": "boolean" + }, + { + "description": "true if network is security group enabled, false otherwise", + "length": 255, + "name": "securitygroupenabled", + "required": false, + "type": "boolean" }, { "description": "the ID of the containing domain, null for public zones", @@ -62116,38 +62124,30 @@ "type": "uuid" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "Network domain name for the networks in the zone", "length": 255, - "name": "ip6dns1", + "name": "domain", "required": false, "type": "string" }, { - "description": "true if the zone is an edge zone, false otherwise", - "length": 255, - "name": "isedge", - "required": false, - "since": "4.18.0", - "type": "boolean" - }, - { - "description": "true if local storage offering enabled, false otherwise", + "description": "the second DNS for the Zone", "length": 255, - "name": "localstorageenabled", + "name": "dns2", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the guest CIDR address for the Zone", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "guestcidraddress", + "name": "ip6dns1", "required": false, "type": "string" }, { - "description": "network type of the zone, can be Basic or Advanced", + "description": "the first DNS for the Zone", "length": 255, - "name": "networktype", + "name": "dns1", "required": true, "type": "string" }, @@ -62159,16 +62159,16 @@ "type": "string" }, { - "description": "Network domain name for the networks in the zone", + "description": "the name of the Zone", "length": 255, - "name": "domain", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the first DNS for the Zone", + "description": "network type of the zone, can be Basic or Advanced", "length": 255, - "name": "dns1", + "name": "networktype", "required": true, "type": "string" }, @@ -62180,18 +62180,18 @@ "type": "string" }, { - "description": "true if network is security group enabled, false otherwise", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "securitygroupenabled", + "name": "internaldns2", "required": false, - "type": "boolean" + "type": "string" } ], "related": "listZones", "response": [ { - "description": "the display text of the zone", - "name": "displaytext", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { @@ -62200,55 +62200,75 @@ "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, + {}, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", + "description": "Zone Token", + "name": "zonetoken", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + { + "description": "Zone description", + "name": "description", + "type": "string" + }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, { "description": "The maximum value the MTU can have on the VR's public interfaces", "name": "routerpublicinterfacemaxmtu", "type": "integer" }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, { "description": "the second IPv6 DNS for the Zone", "name": "ip6dns2", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", "type": "boolean" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", - "type": "boolean" + "description": "the type of the zone - core or edge", + "name": "type", + "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "Allow end users to specify VR MTU", @@ -62256,234 +62276,214 @@ "type": "boolean" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" + }, + { + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the capacity name", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod name", - "name": "podname", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" } ], - "type": "list" - }, - { - "description": "Network domain name for the networks in the zone", - "name": "domain", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "AS Number Range", - "name": "asnrange", - "type": "string" - }, - { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "type": "set" }, {}, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" - }, - { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "tag key name", - "name": "key", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the Zone ID", + "name": "zoneid", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "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", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "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 security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "Zone name", - "name": "name", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "Zone description", - "name": "description", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "the type of the zone - core or edge", - "name": "type", - "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", - "name": "dns1", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" + "description": "Zone name", + "name": "name", + "type": "string" } ] }, @@ -62493,23 +62493,31 @@ "name": "listDomainChildren", "params": [ { - "description": "flag to display the resource icon for domains", + "description": "list children domains by name", "length": 255, - "name": "showicon", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list children domains by name", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", + "description": "list children domain by parent domain ID.", "length": 255, - "name": "isrecursive", + "name": "id", + "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", + "length": 255, + "name": "listall", "required": false, "type": "boolean" }, @@ -62523,99 +62531,92 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "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", + "description": "flag to display the resource icon for domains", "length": 255, - "name": "listall", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "list children domain by parent domain ID.", - "length": 255, - "name": "id", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "createDomain,listDomains,listDomains,moveDomain", "response": [ { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "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", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the level of the domain", - "name": "level", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" }, { "description": "the total number of projects being administrated by this domain", @@ -62623,64 +62624,43 @@ "type": "long" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "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", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { @@ -62689,99 +62669,119 @@ "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "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 domain can own", - "name": "secondarystoragelimit", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, { "description": "the total number of public ip addresses this domain can acquire", "name": "iplimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, - {}, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "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", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "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", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the path of the domain", - "name": "path", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, { @@ -62790,29 +62790,29 @@ "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" + "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 total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" } ] }, @@ -62825,13 +62825,14 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "related": "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 base64 encoded encrypted password of the VM", "name": "encryptedpassword", @@ -62847,8 +62848,7 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { @@ -62860,7 +62860,7 @@ "description": "the list load balancer rules that will be assigned to global load balancer rule", "length": 255, "name": "loadbalancerrulelist", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": true, "type": "list" }, @@ -62881,27 +62881,27 @@ } ], "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -62911,17 +62911,24 @@ "name": "addImageStoreS3", "params": [ { - "description": "Connection timeout (milliseconds)", + "description": "Maximum number of times to retry on error", "length": 255, - "name": "connectiontimeout", + "name": "maxerrorretry", "required": false, "type": "integer" }, { - "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", + "description": "S3 access key", "length": 255, - "name": "s3signer", - "required": false, + "name": "accesskey", + "required": true, + "type": "string" + }, + { + "description": "S3 endpoint", + "length": 255, + "name": "endpoint", + "required": true, "type": "string" }, { @@ -62946,75 +62953,63 @@ "type": "integer" }, { - "description": "S3 access key", + "description": "Name of the storage bucket", "length": 255, - "name": "accesskey", + "name": "bucket", "required": true, "type": "string" }, { - "description": "S3 endpoint", + "description": "Whether TCP keep-alive is used", "length": 255, - "name": "endpoint", - "required": true, - "type": "string" + "name": "usetcpkeepalive", + "required": false, + "type": "boolean" }, { - "description": "Connection TTL (milliseconds)", + "description": "Connection timeout (milliseconds)", "length": 255, - "name": "connectionttl", + "name": "connectiontimeout", "required": false, "type": "integer" }, { - "description": "Maximum number of times to retry on error", + "description": "Connection TTL (milliseconds)", "length": 255, - "name": "maxerrorretry", + "name": "connectionttl", "required": false, "type": "integer" }, { - "description": "Whether TCP keep-alive is used", + "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", "length": 255, - "name": "usetcpkeepalive", + "name": "s3signer", "required": false, - "type": "boolean" - }, - { - "description": "Name of the storage bucket", - "length": 255, - "name": "bucket", - "required": true, "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", "response": [ - { - "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 Zone name of the image store", - "name": "zonename", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the url of the image store", - "name": "url", + "description": "the protocol of the image store", + "name": "protocol", "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 total disk size of the host", @@ -63022,46 +63017,51 @@ "type": "long" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the name of the image store", + "name": "name", + "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the url of the image store", + "name": "url", "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" }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, { "description": "defines if store is read-only", "name": "readonly", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - {}, - { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - } + {} ], "since": "4.7.0" }, @@ -63071,11 +63071,12 @@ "name": "uploadTemplateDirectDownloadCertificate", "params": [ { - "description": "Hypervisor type", + "description": "(optional) the host ID to upload certificate", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { "description": "Name for the uploaded certificate", @@ -63085,20 +63086,11 @@ "type": "string" }, { - "description": "Zone to upload certificate", + "description": "Hypervisor type", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "hypervisor", "required": true, - "type": "uuid" - }, - { - "description": "(optional) the host ID to upload certificate", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", - "required": false, - "type": "uuid" + "type": "string" }, { "description": "SSL certificate", @@ -63106,65 +63098,62 @@ "name": "certificate", "required": true, "type": "string" + }, + { + "description": "Zone to upload certificate", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "listTemplateDirectDownloadCertificates", "response": [ { - "description": "the direct download certificate alias", - "name": "alias", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "the direct download certificate id", "name": "id", "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "validity", - "type": "string" - }, - { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the direct download certificate alias", + "name": "alias", "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "issuer", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -63172,10 +63161,21 @@ "name": "hostsmap", "type": "list" }, + {}, { "description": "the direct download certificate version", "name": "version", "type": "string" + }, + { + "description": "the direct download certificate issuer", + "name": "validity", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.11.0" @@ -63186,39 +63186,47 @@ "name": "importUnmanagedInstance", "params": [ { - "description": "VM nic to network id mapping using keys nic and network", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "nicnetworklist", + "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": "map" + "type": "uuid" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "description": "used to specify the custom parameters.", "length": 255, - "name": "migrateallowed", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the name of the instance as it is known to the hypervisor", + "description": "the host name of the instance", "length": 255, - "name": "name", - "required": true, + "name": "hostname", + "required": false, "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "the display name of the instance", "length": 255, - "name": "account", + "name": "displayname", "required": false, "type": "string" }, { - "description": "the host name of the instance", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "hostname", + "name": "datadiskofferinglist", "required": false, - "type": "string" + "type": "map" + }, + { + "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": "import instance to the domain specified", @@ -63229,629 +63237,182 @@ "type": "uuid" }, { - "description": "the service offering for the virtual machine", + "description": "the name of the instance as it is known to the hypervisor", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" }, { - "description": "the display name of the instance", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "displayname", + "name": "account", "required": false, "type": "string" }, { - "description": "import instance for the project", + "description": "the service offering for the virtual machine", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", - "required": false, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "nicipaddresslist", + "name": "nicnetworklist", "required": false, "type": "map" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "VM nic to ip address mapping using keys nic, ip4Address", "length": 255, - "name": "datadiskofferinglist", + "name": "nicipaddresslist", "required": false, "type": "map" }, { - "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": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", "length": 255, - "name": "forced", + "name": "migrateallowed", "required": false, "type": "boolean" }, { - "description": "the ID of the template for the virtual machine", + "description": "import instance for the project", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "projectid", + "related": "activateProject,createProject", "required": false, "type": "uuid" - }, - { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - }, - { - "description": "used to specify the custom parameters.", - "length": 255, - "name": "details", - "required": false, - "type": "map" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "related": "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 project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "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 date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the name of the virtual machine", + "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 name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the account owning the affinity 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": "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": "customer associated with the tag", - "name": "customer", - "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" - }, - { - "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" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", + "description": "the project ID of the affinity group", "name": "projectid", "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 account owning the security group", - "name": "account", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "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 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 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 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": "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": "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": "customer associated with the tag", - "name": "customer", - "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 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 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": "security group name", - "name": "securitygroupname", - "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": "the project id the tag belongs to", - "name": "projectid", - "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": "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": "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" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the project name of the group", + "description": "the project name of the affinity group", "name": "project", "type": "string" }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "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 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 type of the affinity group", - "name": "type", - "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 domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "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.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "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 password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "name": "publicip", "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", + "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { @@ -63859,201 +63420,125 @@ "name": "domainpath", "type": "string" }, - { - "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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "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", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the group name of the virtual machine", + "name": "group", "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "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": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, { "description": "ID of AutoScale VM group", "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "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", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { "description": "User VM type", @@ -64066,47 +63551,42 @@ "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "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", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "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": "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" }, { @@ -64115,13 +63595,13 @@ "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 value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -64129,11 +63609,6 @@ "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", @@ -64148,43 +63623,23 @@ "description": "customer associated with the tag", "name": "customer", "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" } ], "type": "set" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "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 memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -64192,18 +63647,23 @@ "name": "nic", "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "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", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -64217,23 +63677,33 @@ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "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 broadcast uri of the nic", - "name": "broadcasturi", + "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" }, { @@ -64242,20 +63712,40 @@ "type": "boolean" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "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": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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": "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", @@ -64267,33 +63757,38 @@ "type": "integer" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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" }, { @@ -64302,91 +63797,596 @@ "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + } + ], + "type": "set" + }, + { + "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 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 control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "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 isolation uri of the nic", - "name": "isolationuri", + "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 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 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" + }, + { + "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 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 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": "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": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the name of the security group", + "name": "name", + "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "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 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" + }, + { + "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": "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 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": "tag key name", + "name": "key", + "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 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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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": "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": "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 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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "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" } ], "type": "set" }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the project id of the vm", + "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 date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + {}, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "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": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, { "description": "the target memory in VM (KiB)", "name": "memorytargetkbs", "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "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 user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "VNF details", "name": "vnfdetails", "type": "map" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "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", + "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": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" } ], @@ -64398,25 +64398,19 @@ "name": "createPhysicalNetwork", "params": [ { - "description": "the name of the physical network", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Tag the physical network", + "description": "the isolation method for the physical network[VLAN/L3/GRE]", "length": 255, - "name": "tags", + "name": "isolationmethods", "required": false, "type": "list" }, { - "description": "the speed for the physical network[1G/10G]", + "description": "domain ID of the account owning a physical network", "length": 255, - "name": "networkspeed", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "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", @@ -64426,27 +64420,25 @@ "type": "string" }, { - "description": "domain ID of the account owning a physical network", + "description": "the name of the physical network", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the isolation method for the physical network[VLAN/L3/GRE]", + "description": "Tag the physical network", "length": 255, - "name": "isolationmethods", + "name": "tags", "required": false, "type": "list" }, { - "description": "the Zone ID for the physical network", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "networkspeed", + "required": false, + "type": "string" }, { "description": "the VLAN for the physical network", @@ -64454,30 +64446,37 @@ "name": "vlan", "required": false, "type": "string" + }, + { + "description": "the Zone ID for the physical network", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "listPhysicalNetworks,updatePhysicalNetwork", "response": [ { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "state of the physical network", + "name": "state", "type": "string" }, + {}, { "description": "the uuid of the physical network", "name": "id", "type": "string" }, - {}, - {}, { - "description": "comma separated tag", - "name": "tags", + "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", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { @@ -64486,43 +64485,44 @@ "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "isolation methods", + "name": "isolationmethods", "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": "the speed of the physical network", - "name": "networkspeed", + "description": "name of the physical network", + "name": "name", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "state of the physical network", - "name": "state", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" } ], @@ -64537,24 +64537,23 @@ "description": "the ID of the loadbalancer", "length": 255, "name": "lbruleid", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the name of the autoscale vmgroup", @@ -64564,6 +64563,14 @@ "since": "4.18.0", "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": "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, @@ -64572,34 +64579,34 @@ "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the availability zone ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the profile", "length": 255, - "name": "page", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", "required": false, - "type": "integer" + "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 account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the ID of the autoscale vm group", @@ -64609,14 +64616,6 @@ "required": false, "type": "uuid" }, - { - "description": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, { "description": "the ID of the policy", "length": 255, @@ -64626,90 +64625,77 @@ "type": "uuid" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "activateProject,createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the profile", + "description": "", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "enableAutoScaleVmGroup", "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": "list of scaledown autoscale policies", "name": "scaledownpolicies", "type": "list" }, { - "description": "the project id of the vm group", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" - }, - { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the public port", + "name": "publicport", "type": "string" }, - { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "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 public ip address", "name": "publicip", "type": "string" }, + {}, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, + {}, { - "description": "the public port", - "name": "publicport", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { "description": "the name of the autoscale vm group ", @@ -64717,45 +64703,54 @@ "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { "description": "the domain ID of the vm group", "name": "domainid", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "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", + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" + }, + { + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", "type": "int" }, { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the account owning the vm group", - "name": "account", - "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 vm group", - "name": "project", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "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 number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { "description": "the id of the guest network the lb rule belongs to", @@ -64763,39 +64758,44 @@ "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the project id of the vm group", + "name": "projectid", "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 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", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the project name of the vm group", + "name": "project", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -64805,16 +64805,16 @@ "name": "updatePod", "params": [ { - "description": "the gateway for the Pod", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "gateway", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the ending IP address for the Pod", + "description": "the gateway for the Pod", "length": 255, - "name": "endip", + "name": "gateway", "required": false, "type": "string" }, @@ -64833,9 +64833,9 @@ "type": "string" }, { - "description": "the name of the Pod", + "description": "the ending IP address for the Pod", "length": 255, - "name": "name", + "name": "endip", "required": false, "type": "string" }, @@ -64848,195 +64848,195 @@ "type": "uuid" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the name of the Pod", "length": 255, - "name": "allocationstate", + "name": "name", "required": false, "type": "string" } ], "related": "createPod,listPods,createManagementNetworkIpRange", "response": [ - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, { "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": "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 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", + "description": "the Zone name of the Pod", + "name": "zonename", "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 allocation state of the Pod", + "name": "allocationstate", + "type": "string" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", + "description": "the capacity of the Pod", + "name": "capacity", "response": [ { - "description": "the starting IP for the range", - "name": "startip", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the gateway for the range", - "name": "gateway", + "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 gateway of the Pod", - "name": "gateway", - "type": "string" - }, - { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ + }, { - "description": "the capacity name", - "name": "name", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, + "description": "the Zone name", + "name": "zonename", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ { - "description": "the Pod name", - "name": "podname", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the ending IP for the range", + "name": "endip", + "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" } ], "type": "list" }, + { + "description": "the name of the Pod", + "name": "name", + "type": "string" + }, + { + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the ID of the Pod", "name": "id", "type": "string" }, { - "description": "the name of the Pod", - "name": "name", + "description": "the Zone ID of the Pod", + "name": "zoneid", "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 starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, {}, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" + }, + {}, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" } ] }, @@ -65045,11 +65045,19 @@ "isasync": true, "name": "attachIso", "params": [ + { + "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" + }, { "description": "the ID of the virtual machine", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "related": "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" }, @@ -65060,94 +65068,441 @@ "required": false, "since": "4.15.1", "type": "boolean" - }, - { - "description": "the ID of the ISO file", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "related": "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 state of the virtual machine", - "name": "state", + "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 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": "State of the Service from LB rule", - "name": "servicestate", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "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 domain in which the virtual machine exists", "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "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 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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, + {}, { "description": "Vm details in key/value pairs.", "name": "details", "type": "map" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "OS type id of the vm", + "name": "ostypeid", "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 name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + {}, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "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": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "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 isolation uri of the nic", + "name": "isolationuri", + "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 Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "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 type of the nic", + "name": "type", + "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": "the ID of the nic", + "name": "id", + "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" + }, + { + "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": "the ip address of the nic", + "name": "ipaddress", + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "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" + } + ], + "type": "set" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + {}, + { + "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 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", + "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": "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" }, { @@ -65156,8 +65511,18 @@ "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "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" }, { @@ -65171,13 +65536,13 @@ "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 id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -65185,8 +65550,13 @@ "name": "tags", "response": [ { - "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", "type": "string" }, { @@ -65195,33 +65565,33 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "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" }, { @@ -65230,44 +65600,29 @@ "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", + "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" } ], "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": "path of the Domain the security group belongs to", - "name": "domainpath", + "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", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -65275,16 +65630,6 @@ "name": "account", "type": "string" }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, { "description": "the domain ID of the security group", "name": "domainid", @@ -65295,28 +65640,28 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "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": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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": "tag key name", + "name": "key", "type": "string" }, { @@ -65325,8 +65670,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -65335,42 +65680,52 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "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": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "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 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": "security group name", "name": "securitygroupname", @@ -65381,43 +65736,33 @@ "name": "cidr", "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "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 account associated with the tag", + "name": "account", "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -65426,28 +65771,28 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], @@ -65458,95 +65803,90 @@ "name": "ruleid", "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": "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": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project id of the group", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "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 format of the template for the virtual machine", - "name": "templateformat", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -65559,13 +65899,13 @@ "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": "tag value", + "name": "value", "type": "string" }, { @@ -65574,23 +65914,23 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -65599,39 +65939,42 @@ "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": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, - {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "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 read (IO) of disk on the VM", - "name": "diskioread", - "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 ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { "description": "Os type ID of the virtual machine", @@ -65639,264 +65982,57 @@ "type": "string" }, { - "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": "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 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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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 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": "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "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 netmask of the nic", - "name": "netmask", - "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 gateway of IPv6 network", - "name": "ip6gateway", - "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "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" - } - ], - "type": "set" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "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", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "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", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "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": "publicip", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "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", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "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", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { @@ -65905,8 +66041,8 @@ "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { @@ -65915,196 +66051,91 @@ "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project name of the affinity group", + "name": "project", "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 account owning the affinity group", - "name": "account", + "description": "the project ID of the affinity group", + "name": "projectid", "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 project name of the affinity group", - "name": "project", - "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 name of the affinity group", + "name": "name", + "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": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "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": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "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 service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "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": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { @@ -66113,24 +66144,14 @@ "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "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", @@ -66138,31 +66159,10 @@ "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "User VM type", - "name": "vmtype", - "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 project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" - }, - {} + } ] }, { @@ -66173,19 +66173,13 @@ "related": "", "response": [ { - "description": "DN password", - "name": "bindpass", - "type": "string" - }, - { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, { @@ -66194,14 +66188,14 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "DN password", + "name": "bindpass", "type": "string" }, { @@ -66210,15 +66204,21 @@ "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" - } + }, + { + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", + "type": "string" + }, + {} ], "since": "3.0.1" }, @@ -66228,178 +66228,183 @@ "name": "createUser", "params": [ { - "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.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "password", - "required": true, + "name": "timezone", + "required": false, "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "name": "account", + "required": true, + "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "firstname", "length": 255, - "name": "timezone", - "required": false, + "name": "firstname", + "required": true, "type": "string" }, { - "description": "Unique username.", + "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": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "lastname", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "lastname", - "required": true, + "name": "userid", + "required": false, "type": "string" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "email", "length": 255, - "name": "account", + "name": "email", "required": true, "type": "string" }, { - "description": "firstname", + "description": "lastname", "length": 255, - "name": "firstname", + "name": "lastname", "required": true, "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "Unique username.", "length": 255, - "name": "userid", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "email", + "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", "length": 255, - "name": "email", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" } ], "related": "disableUser,getUser,listUsers,lockUser", "response": [ { - "description": "the user state", - "name": "state", + "description": "the name of the role", + "name": "rolename", "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", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, + {}, + {}, { - "description": "the user email address", - "name": "email", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "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 source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" }, - {}, { "description": "the date and time the user account was created", "name": "created", "type": "date" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the account name of the user", + "name": "account", "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 account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the user state", + "name": "state", + "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 timezone user was created in", - "name": "timezone", - "type": "string" + "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": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the api key of the user", @@ -66407,24 +66412,19 @@ "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the ID of the role", + "name": "roleid", "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 account type of the user", + "name": "accounttype", + "type": "integer" } ] }, @@ -66452,31 +66452,24 @@ ], "related": "updateVpnGateway", "response": [ - { - "description": "the vpc id of this gateway", - "name": "vpcid", - "type": "string" - }, { "description": "the vpc name of this gateway", "name": "vpcname", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "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 project id", + "name": "projectid", "type": "string" }, - {}, - {}, { - "description": "the project name", - "name": "project", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { @@ -66485,44 +66478,51 @@ "type": "boolean" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the owner", + "name": "account", + "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the owner", - "name": "account", + "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" }, + {}, { "description": "the domain name of the owner", "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + {}, + { + "description": "the vpc id of this gateway", + "name": "vpcid", + "type": "string" } ] }, @@ -66531,13 +66531,6 @@ "isasync": true, "name": "addResourceDetail", "params": [ - { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": true, - "type": "map" - }, { "description": "type of the resource", "length": 255, @@ -66553,6 +66546,13 @@ "since": "4.4", "type": "boolean" }, + { + "description": "Map of (key/value pairs)", + "length": 255, + "name": "details", + "required": true, + "type": "map" + }, { "description": "resource id to create the details for", "length": 255, @@ -66563,26 +66563,26 @@ ], "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" } ] }, @@ -66592,64 +66592,63 @@ "name": "listVpnUsers", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject", - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "the username of the vpn user.", + "description": "List by keyword", "length": 255, - "name": "username", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "activateProject,createProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the username of the vpn user.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "username", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "The uuid of the Vpn user", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "addVpnUser,listVpnUsers", + "name": "domainid", + "related": "createDomain,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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -66658,26 +66657,27 @@ "type": "string" }, { - "description": "", + "description": "The uuid of the Vpn user", "length": 255, - "name": "pagesize", + "name": "id", + "related": "addVpnUser,listVpnUsers", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "addVpnUser", "response": [ - {}, { - "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", - "name": "state", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -66693,35 +66693,35 @@ "name": "project", "type": "string" }, + {}, { - "description": "the vpn userID", - "name": "id", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, - {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the vpn userID", + "name": "id", "type": "string" } ] @@ -66735,21 +66735,23 @@ "description": "the ID of the forwarding rule", "length": 255, "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,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": "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", @@ -66757,12 +66759,10 @@ "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" + } ] }, { @@ -66770,6 +66770,13 @@ "isasync": false, "name": "registerUserData", "params": [ + { + "description": "an optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "Base64 encoded userdata content. 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, @@ -66778,11 +66785,12 @@ "type": "string" }, { - "description": "Name of the userdata", + "description": "an optional project for the userdata", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "projectid", + "related": "activateProject,createProject", + "required": false, + "type": "uuid" }, { "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", @@ -66793,51 +66801,43 @@ "type": "uuid" }, { - "description": "comma separated list of variables declared in userdata content", + "description": "Name of the userdata", "length": 255, - "name": "params", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "an optional project for the userdata", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject", - "required": false, - "type": "uuid" - }, - { - "description": "an optional account for the userdata. Must be used with domainId.", + "description": "comma separated list of variables declared in userdata content", "length": 255, - "name": "account", + "name": "params", "required": false, "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", "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.18" }, @@ -66847,11 +66847,11 @@ "name": "addRegion", "params": [ { - "description": "Id of the Region", + "description": "Region service endpoint", "length": 255, - "name": "id", + "name": "endpoint", "required": true, - "type": "integer" + "type": "string" }, { "description": "Name of the region", @@ -66861,37 +66861,27 @@ "type": "string" }, { - "description": "Region service endpoint", + "description": "Id of the Region", "length": 255, - "name": "endpoint", + "name": "id", "required": true, - "type": "string" + "type": "integer" } ], "related": "updateRegion", "response": [ + {}, + {}, { "description": "true if GSLB service is enabled in the region, false otherwise", "name": "gslbserviceenabled", "type": "boolean" }, - {}, { "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": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -66902,10 +66892,20 @@ "name": "name", "type": "string" }, + { + "description": "the ID of the region", + "name": "id", + "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" } ] }, @@ -66914,13 +66914,6 @@ "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": false, - "type": "date" - }, { "description": "List events for the specified domain.", "length": 255, @@ -66935,10 +66928,27 @@ "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": "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", @@ -66949,17 +66959,7 @@ "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" - } + {} ] }, { @@ -66967,6 +66967,14 @@ "isasync": false, "name": "updateRolePermission", "params": [ + { + "description": "ID of the role", + "length": 255, + "name": "roleid", + "related": "createRole,listRoles,updateRole", + "required": true, + "type": "uuid" + }, { "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, @@ -66976,54 +66984,46 @@ "type": "list" }, { - "description": "Rule permission, can be: allow or deny", + "description": "Role permission rule id", "length": 255, - "name": "permission", + "name": "ruleid", + "related": "", "required": false, "since": "4.11", - "type": "string" - }, - { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "createRole,listRoles,updateRole", - "required": true, "type": "uuid" }, { - "description": "Role permission rule id", + "description": "Rule permission, can be: allow or deny", "length": 255, - "name": "ruleid", - "related": "", + "name": "permission", "required": false, "since": "4.11", - "type": "uuid" + "type": "string" } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.9.0" }, @@ -67033,11 +67033,11 @@ "name": "listAccounts", "params": [ { - "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", + "description": "list accounts by cleanuprequired attribute (values are true or false)", "length": 255, - "name": "accounttype", + "name": "iscleanuprequired", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "list accounts by state. Valid states are enabled, disabled, and locked.", @@ -67046,20 +67046,6 @@ "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": "flag to display the resource icon for accounts", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - }, { "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", "length": 255, @@ -67068,18 +67054,11 @@ "type": "list" }, { - "description": "", - "length": 255, - "name": "pagesize", - "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.", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list only resources belonging to the domain specified", @@ -67090,19 +67069,18 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", "length": 255, - "name": "keyword", + "name": "accounttype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list account by account ID", + "description": "flag to display the resource icon for accounts", "length": 255, - "name": "id", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "Tag for resource type to return usage", @@ -67113,9 +67091,9 @@ "type": "string" }, { - "description": "list accounts by cleanuprequired attribute (values are true or false)", + "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": "iscleanuprequired", + "name": "listall", "required": false, "type": "boolean" }, @@ -67129,81 +67107,78 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" - } - ], - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", - "response": [ - { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "list account by account ID", + "length": 255, + "name": "id", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "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", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" + } + ], + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "response": [ + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "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", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" - }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the type of the role", - "name": "roletype", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "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 date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { "description": "true if user has two factor authentication is mandated", @@ -67211,28 +67186,18 @@ "type": "boolean" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user state", + "name": "state", "type": "string" }, { - "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 secret key of the user", - "name": "secretkey", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -67241,76 +67206,101 @@ "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "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 account ID of the user", - "name": "accountid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the domain ID of the user", - "name": "domainid", + "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 source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the api key of the user", + "name": "apikey", "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 role", + "name": "roleid", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the account ID of the user", + "name": "accountid", "type": "string" } ], "type": "list" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", "type": "boolean" }, { @@ -67319,20 +67309,34 @@ "type": "resourceiconresponse" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, - {}, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { "description": "the total number of network traffic bytes received", @@ -67340,23 +67344,23 @@ "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { @@ -67365,28 +67369,18 @@ "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { @@ -67395,79 +67389,74 @@ "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 vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "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 total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, - {}, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, + {}, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { @@ -67476,99 +67465,110 @@ "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, + {}, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "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", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" } ] }, @@ -67588,91 +67588,170 @@ ], "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the host ID for the router", "name": "hostid", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "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": "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": "result of the health check", - "name": "success", - "type": "boolean" - } - ], - "type": "list" + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" }, { "description": "true if any health checks had failed", "name": "healthchecksfailed", "type": "boolean" }, + {}, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { @@ -67681,72 +67760,154 @@ "type": "integer" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the IPv6 address of network", + "name": "ip6address", "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 gateway of the nic", - "name": "gateway", + "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", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -67755,9 +67916,9 @@ "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { "description": "true if nic is default, false otherwise", @@ -67765,84 +67926,94 @@ "type": "boolean" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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", + "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": "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 type of the nic", + "name": "type", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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": "device id for the network when plugged into the virtual machine", "name": "deviceid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "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", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { "description": "the isolation uri of the nic", @@ -67854,6 +68025,11 @@ "name": "vlanid", "type": "integer" }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, { "description": "Type of adapter if available", "name": "adaptertype", @@ -67863,345 +68039,169 @@ "type": "set" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, + {}, { - "description": "the template name for the router", - "name": "templatename", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Lists image stores.", + "isasync": false, + "name": "listImageStores", + "params": [ { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the image store", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the image store protocol", + "length": 255, + "name": "protocol", + "required": false, "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "the Zone ID for the image store", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" + "description": "the ID of the storage pool", + "length": 255, + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", + "required": false, + "type": "uuid" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "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 hostname for the router", - "name": "hostname", + "description": "the image store provider", + "length": 255, + "name": "provider", + "required": false, "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, + } + ], + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore", + "response": [ { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - {}, - {}, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "path of the Domain the router belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "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": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - } - ] - }, - { - "description": "Lists image stores.", - "isasync": false, - "name": "listImageStores", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the image store provider", - "length": 255, - "name": "provider", - "required": false, + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the image store protocol", - "length": 255, + "description": "the protocol of the image store", "name": "protocol", - "required": false, - "type": "string" - }, - { - "description": "the ID of the storage pool", - "length": 255, - "name": "id", - "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the name of the image store", - "length": 255, - "name": "name", - "required": false, "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the Zone ID for the image store", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "read-only status of the image store", - "length": 255, + "description": "defines if store is read-only", "name": "readonly", - "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", - "required": false, - "since": "4.15.0", - "type": "boolean" - } - ], - "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore", - "response": [ - { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", "type": "boolean" }, { - "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 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 Zone name of the image store", - "name": "zonename", - "type": "string" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, { "description": "the scope of the image store", "name": "scope", "type": "scopetype" }, + {}, + {}, { - "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" }, { - "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 url of the image store", - "name": "url", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the name of the image store", + "name": "name", "type": "string" }, - {}, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" } ], "since": "4.2.0" @@ -68221,7 +68221,6 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -68233,6 +68232,7 @@ "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -68266,68 +68266,68 @@ "name": "jobstatus", "type": "integer" }, - { - "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": "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 operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the operation result description", + "name": "description", + "type": "string" + }, { "description": "the ID of the host", "name": "hostid", "type": "string" }, - {}, { "description": "the out-of-band management action (if issued)", "name": "action", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, + {}, { - "description": "the out-of-band management interface username", - "name": "username", - "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", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, - { - "description": "the operation result", - "name": "status", - "type": "boolean" - } + {} ], "since": "4.9.0" }, @@ -68348,288 +68348,226 @@ "related": "createProject", "response": [ { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" }, + {}, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "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 networks available to be created for this project", + "name": "networkavailable", + "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the list of resource tags associated with vm", - "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 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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "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", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "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": "the displaytext of the project", - "name": "displaytext", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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 virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, - {}, { "description": "the name of the project", "name": "name", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" - }, - {}, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the state of the project", - "name": "state", - "type": "string" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "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", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "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 date this project was created", - "name": "created", - "type": "date" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, + {}, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "the total number of vpcs owned by project", "name": "vpctotal", "type": "long" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "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 templates available to be created by this project", - "name": "templateavailable", - "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 the project can own", - "name": "networklimit", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { "description": "the total number of virtual machines deployed by this project", @@ -68637,19 +68575,81 @@ "type": "long" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the id of the project", + "name": "id", "type": "string" }, { "description": "The tagged resource limit and count for the project", "name": "taggedresources", "type": "list" + }, + { + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "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" + }, + { + "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" + }, + { + "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" + } + ], + "type": "list" } ], "since": "3.0.0" @@ -68674,23 +68674,23 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -68699,11 +68699,11 @@ "name": "deleteAlerts", "params": [ { - "description": "delete by alert type", + "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": "type", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { "description": "the IDs of the alerts", @@ -68714,11 +68714,11 @@ "type": "list" }, { - "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": "delete by alert type", "length": 255, - "name": "startdate", + "name": "type", "required": false, - "type": "date" + "type": "string" }, { "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", @@ -68729,16 +68729,8 @@ } ], "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", @@ -68749,8 +68741,16 @@ "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" + } ] }, { @@ -68758,14 +68758,6 @@ "isasync": true, "name": "createAutoScaleVmProfile", "params": [ - { - "description": "the template of the auto deployed virtual machine", - "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" - }, { "description": "used to specify the parameters values for the variables in userdata.", "length": 255, @@ -68775,82 +68767,82 @@ "type": "map" }, { - "description": "the time allowed for existing connections to get closed before a vm is expunged", + "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": "expungevmgraceperiod", + "name": "otherdeployparams", "required": false, - "type": "integer" + "type": "map" }, { - "description": "an optional field, whether to the display the profile to the end user or not", - "length": 255, - "name": "fordisplay", + "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.4", - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "the ID of the Userdata", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "since": "4.18.1", + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "domain ID of the account owning a autoscale VM profile", + "description": "the service offering of the auto deployed virtual machine", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" }, { - "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 profile to the end user or not", "length": 255, - "name": "counterparam", + "name": "fordisplay", "required": false, - "type": "map" + "since": "4.4", + "type": "boolean" }, { - "description": "an optional project for the autoscale VM profile", + "description": "the template of the auto deployed virtual machine", "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, + "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": "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\".", + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", "length": 255, - "name": "otherdeployparams", + "name": "counterparam", "required": false, "type": "map" }, { - "description": "the service offering of the auto deployed virtual machine", + "description": "the time allowed for existing connections to get closed before a vm is expunged", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "expungevmgraceperiod", + "required": false, + "type": "integer" }, { - "description": "availability zone for the auto deployed virtual machine", + "description": "the ID of the Userdata", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18.1", "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", + "description": "the ID of the user used to launch and destroy the VMs", + "length": 255, + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { "description": "account that will own the autoscale VM profile", @@ -68860,10 +68852,18 @@ "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "an optional project for the autoscale VM profile", "length": 255, - "name": "autoscaleuserid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "domain ID of the account owning a autoscale VM profile", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" } @@ -68871,96 +68871,91 @@ "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", "response": [ { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "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 vm profile belongs", - "name": "domainpath", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "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", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", - "type": "string" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { "description": "the project id vm profile", "name": "projectid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, - {}, { "description": "the autoscale vm profile ID", "name": "id", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "Base64 encoded VM user data", - "name": "userdata", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "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", + "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": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, - {}, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { @@ -68969,16 +68964,21 @@ "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, - {}, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "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" - } + }, + {} ] }, { @@ -68986,20 +68986,6 @@ "isasync": false, "name": "registerOauthProvider", "params": [ - { - "description": "Name of the provider from the list of OAuth providers supported in CloudStack", - "length": 255, - "name": "provider", - "required": true, - "type": "string" - }, - { - "description": "Secret Key pre-registered in the specific OAuth provider", - "length": 255, - "name": "secretkey", - "required": true, - "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, @@ -69014,6 +69000,13 @@ "required": true, "type": "string" }, + { + "description": "Description of the OAuth Provider", + "length": 255, + "name": "description", + "required": true, + "type": "string" + }, { "description": "Client ID pre-registered in the specific OAuth provider", "length": 255, @@ -69022,18 +69015,25 @@ "type": "string" }, { - "description": "Description of the OAuth Provider", + "description": "Secret Key pre-registered in the specific OAuth provider", "length": 255, - "name": "description", + "name": "secretkey", + "required": true, + "type": "string" + }, + { + "description": "Name of the provider from the list of OAuth providers supported in CloudStack", + "length": 255, + "name": "provider", "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" }, {}, {}, @@ -69042,15 +69042,15 @@ "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.19.0" @@ -69060,6 +69060,13 @@ "isasync": false, "name": "listLBStickinessPolicies", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the ID of the load balancer stickiness policy", "length": 255, @@ -69068,6 +69075,13 @@ "required": false, "type": "uuid" }, + { + "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, @@ -69087,49 +69101,62 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": false, "type": "uuid" - }, + } + ], + "related": "createLBStickinessPolicy,updateLBStickinessPolicy", + "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 by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the state of the policy", + "name": "state", "type": "string" - } - ], - "related": "createLBStickinessPolicy,updateLBStickinessPolicy", - "response": [ + }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the description of the Stickiness policy", + "name": "description", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {}, + { + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ - { - "description": "the LB Stickiness policy ID", - "name": "id", - "type": "string" - }, { "description": "the name of the Stickiness policy", "name": "name", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { @@ -69137,6 +69164,11 @@ "name": "params", "type": "map" }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, { "description": "is policy for display to the regular user", "name": "fordisplay", @@ -69155,43 +69187,6 @@ ], "type": "list" }, - {}, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the domain of the Stickiness policy", - "name": "domain", - "type": "string" - }, { "description": "the account of the Stickiness policy", "name": "account", @@ -69201,6 +69196,11 @@ "description": "the LB rule ID", "name": "lbruleid", "type": "string" + }, + { + "description": "the domain ID of the Stickiness policy", + "name": "domainid", + "type": "string" } ], "since": "3.0.0" @@ -69211,9 +69211,9 @@ "name": "addUcsManager", "params": [ { - "description": "the password of UCS", + "description": "the username of UCS", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, @@ -69226,61 +69226,61 @@ "type": "uuid" }, { - "description": "the name of UCS url", + "description": "the password of UCS", "length": 255, - "name": "url", + "name": "password", "required": true, "type": "string" }, { - "description": "the username of UCS", + "description": "the name of UCS manager", "length": 255, - "name": "username", - "required": true, + "name": "name", + "required": false, "type": "string" }, { - "description": "the name of UCS manager", + "description": "the name of UCS url", "length": 255, - "name": "name", - "required": false, + "name": "url", + "required": true, "type": "string" } ], "related": "listUcsManagers", "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 url of ucs manager", + "name": "url", + "type": "string" }, { "description": "the zone ID of ucs manager", "name": "zoneid", "type": "string" }, + {}, { - "description": "the url of ucs manager", - "name": "url", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ID of the ucs manager", "name": "id", "type": "string" }, - {}, { "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" - } + {} ] }, { @@ -69288,14 +69288,6 @@ "isasync": true, "name": "deleteVnfTemplate", "params": [ - { - "description": "Force delete a template.", - "length": 255, - "name": "forced", - "required": false, - "since": "4.9+", - "type": "boolean" - }, { "description": "Necessary if the template's type is system.", "length": 255, @@ -69308,7 +69300,7 @@ "description": "the ID of the template", "length": 255, "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "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" }, @@ -69319,19 +69311,22 @@ "related": "listZones", "required": false, "type": "uuid" + }, + { + "description": "Force delete a template.", + "length": 255, + "name": "forced", + "required": false, + "since": "4.9+", + "type": "boolean" } ], "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", @@ -69339,11 +69334,16 @@ "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.19.0" }, @@ -69355,37 +69355,37 @@ { "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" }, { - "description": "the Physical Network ID", + "description": "netscaler load balancer device ID", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "netscaler load balancer device ID", + "description": "the Physical Network ID", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" } @@ -69393,40 +69393,49 @@ "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ { - "description": "device name", - "name": "lbdevicename", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "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": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "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", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "type": "string" + }, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { @@ -69440,40 +69449,31 @@ "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 private interface of the load balancer", - "name": "privateinterface", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", "type": "boolean" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "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": "name of the provider", "name": "provider", "type": "string" }, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -69487,18 +69487,12 @@ "name": "createInstanceGroup", "params": [ { - "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", + "description": "the domain ID of account owning the instance group", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "string" - }, - { - "description": "the name of the instance group", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "type": "uuid" }, { "description": "The project of the instance group", @@ -69509,30 +69503,35 @@ "type": "uuid" }, { - "description": "the domain ID of account owning the instance group", + "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "the name of the instance group", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "updateInstanceGroup", "response": [ { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { @@ -69541,46 +69540,47 @@ "type": "boolean" }, { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", + "description": "the project name of the instance group", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the ID of the instance group", + "name": "id", "type": "string" }, + {}, { "description": "the name of the instance group", "name": "name", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", + "description": "the project ID of the instance group", + "name": "projectid", "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": "time and date the instance group 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 instance group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the instance group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" - }, - {} + } ] }, { @@ -69589,11 +69589,11 @@ "name": "createLoadBalancer", "params": [ { - "description": "the source port the network traffic will be load balanced from", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "sourceport", + "name": "algorithm", "required": true, - "type": "integer" + "type": "string" }, { "description": "the description of the load balancer", @@ -69603,9 +69603,16 @@ "type": "string" }, { - "description": "The guest network the load balancer will be created for", + "description": "the source IP address the network traffic will be load balanced from", "length": 255, - "name": "networkid", + "name": "sourceipaddress", + "required": false, + "type": "string" + }, + { + "description": "the network id of the source ip address", + "length": 255, + "name": "sourceipaddressnetworkid", "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": true, "type": "uuid" @@ -69625,34 +69632,13 @@ "type": "string" }, { - "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 network id of the source ip address", + "description": "The guest network the load balancer will be created for", "length": 255, - "name": "sourceipaddressnetworkid", + "name": "networkid", "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": true, "type": "uuid" }, - { - "description": "the source IP address the network traffic will be load balanced from", - "length": 255, - "name": "sourceipaddress", - "required": false, - "type": "string" - }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -69660,84 +69646,104 @@ "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "the source port the network traffic will be load balanced from", + "length": 255, + "name": "sourceport", + "required": true, + "type": "integer" + }, + { + "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" } ], "related": "", "response": [ + { + "description": "the Load Balancer ID", + "name": "id", + "type": "string" + }, + { + "description": "the description of the Load Balancer", + "name": "description", + "type": "string" + }, + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" + }, { "description": "the domain of the Load Balancer", "name": "domain", "type": "string" }, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "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" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "the Load Balancer ID", - "name": "id", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", "response": [ { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" + "description": "the ip address of the instance", + "name": "ipaddress", + "type": "string" }, { - "description": "the state of the load balancer rule", + "description": "the state of the instance", "name": "state", "type": "string" }, { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" + "description": "the instance ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the instance", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", - "type": "string" - }, - { - "description": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain ID of the Load Balancer", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, + {}, { "description": "the list of resource tags associated with the Load Balancer", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -69746,117 +69752,111 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", + "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 list of rules associated with the Load Balancer", + "name": "loadbalancerrule", "response": [ { - "description": "the state of the instance", + "description": "the state of the load balancer rule", "name": "state", "type": "string" }, { - "description": "the instance ID", - "name": "id", - "type": "string" - }, - { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" }, { - "description": "the name of the instance", - "name": "name", - "type": "string" + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" } ], "type": "list" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "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 project name of the Load Balancer", - "name": "project", + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, - {}, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "the account of the Load Balancer", + "name": "account", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" - } + }, + {} ], "since": "4.2.0" }, @@ -69866,9 +69866,16 @@ "name": "addPaloAltoFirewall", "params": [ { - "description": "Credentials to reach Palo Alto firewall device", + "description": "supports only PaloAltoFirewall", "length": 255, - "name": "password", + "name": "networkdevicetype", + "required": true, + "type": "string" + }, + { + "description": "URL of the Palo Alto appliance.", + "length": 255, + "name": "url", "required": true, "type": "string" }, @@ -69888,16 +69895,9 @@ "type": "uuid" }, { - "description": "supports only PaloAltoFirewall", - "length": 255, - "name": "networkdevicetype", - "required": true, - "type": "string" - }, - { - "description": "URL of the Palo Alto appliance.", + "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "url", + "name": "password", "required": true, "type": "string" } @@ -69905,97 +69905,97 @@ "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", "response": [ { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "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": "device name", - "name": "fwdevicename", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, {}, + {}, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "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", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" - }, - {} + } ] }, { @@ -70004,62 +70004,54 @@ "name": "createPrivateGateway", "params": [ { - "description": "the gateway of the Private gateway", + "description": "the netmask of the Private gateway", "length": 255, - "name": "gateway", + "name": "netmask", "required": true, "type": "string" }, { - "description": "The isolated network this private gateway is associated to.", - "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, - "since": "4.17.0", - "type": "uuid" - }, - { - "description": "when true bypasses VLAN id/range overlap check during private gateway creation", + "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": "bypassvlanoverlapcheck", + "name": "sourcenatsupported", "required": false, "type": "boolean" }, { - "description": "the ID of the network ACL", + "description": "the uuid of the network offering to use for the private gateways network connection", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, "type": "uuid" }, { - "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", + "description": "The isolated network this private gateway is associated to.", "length": 255, - "name": "sourcenatsupported", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "boolean" + "since": "4.17.0", + "type": "uuid" }, { - "description": "the Physical Network ID the network belongs to", + "description": "when true bypasses VLAN id/range overlap check during private gateway creation", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "bypassvlanoverlapcheck", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the IP address of the Private gateaway", + "description": "the gateway of the Private gateway", "length": 255, - "name": "ipaddress", + "name": "gateway", "required": true, "type": "string" }, { - "description": "the netmask of the Private gateway", + "description": "the IP address of the Private gateaway", "length": 255, - "name": "netmask", + "name": "ipaddress", "required": true, "type": "string" }, @@ -70071,37 +70063,46 @@ "type": "string" }, { - "description": "the VPC network belongs to", + "description": "the Physical Network ID the network belongs to", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", - "required": true, + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "required": false, "type": "uuid" }, { - "description": "the uuid of the network offering to use for the private gateways network connection", + "description": "the ID of the network ACL", "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, "type": "uuid" + }, + { + "description": "the VPC network belongs to", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": true, + "type": "uuid" } ], "related": "createPrivateGateway,listPrivateGateways", "response": [ { - "description": "the project name of the private gateway", - "name": "project", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, + {}, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, { @@ -70109,56 +70110,29 @@ "name": "sourcenatsupported", "type": "boolean" }, - { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" - }, - {}, - { - "description": "zone id of the private gateway", - "name": "zoneid", - "type": "string" - }, - { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" - }, { "description": "the id of the private gateway", "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { @@ -70167,8 +70141,8 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { @@ -70177,8 +70151,8 @@ "type": "integer" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { @@ -70187,8 +70161,13 @@ "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, { @@ -70197,8 +70176,19 @@ "type": "string" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "zone id of the private gateway", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { @@ -70215,6 +70205,16 @@ "description": "ACL Id set for private gateway", "name": "aclid", "type": "string" + }, + { + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.17.0" @@ -70228,33 +70228,33 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "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": "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" + }, {} ] }, @@ -70264,53 +70264,45 @@ "name": "uploadSslCert", "params": [ { - "description": "domain ID of the account owning the SSL certificate", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "description": "Certificate chain of trust", + "length": 2097152, + "name": "certchain", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional project for the SSL certificate", + "description": "Name for the uploaded certificate", "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" - }, - { - "description": "Private key", - "length": 16384, - "name": "privatekey", + "name": "name", "required": true, "type": "string" }, { - "description": "account that will own the SSL certificate", + "description": "Enables revocation checking for certificates", "length": 255, - "name": "account", + "name": "enabledrevocationcheck", "required": false, - "type": "string" + "since": "4.15", + "type": "boolean" }, { - "description": "Name for the uploaded certificate", - "length": 255, - "name": "name", + "description": "Private key", + "length": 16384, + "name": "privatekey", "required": true, "type": "string" }, { - "description": "Certificate chain of trust", - "length": 2097152, - "name": "certchain", + "description": "Password for the private key", + "length": 255, + "name": "password", "required": false, "type": "string" }, { - "description": "Password for the private key", + "description": "account that will own the SSL certificate", "length": 255, - "name": "password", + "name": "account", "required": false, "type": "string" }, @@ -70322,25 +70314,38 @@ "type": "string" }, { - "description": "Enables revocation checking for certificates", + "description": "domain ID of the account owning the SSL certificate", "length": 255, - "name": "enabledrevocationcheck", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "since": "4.15", - "type": "boolean" + "type": "uuid" + }, + { + "description": "an optional project for the SSL certificate", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "SSL certificate ID", + "name": "id", + "type": "string" }, { "description": "the project name of the certificate", @@ -70348,56 +70353,51 @@ "type": "string" }, { - "description": "certificate chain", - "name": "certchain", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "account for the certificate", + "name": "account", "type": "string" }, - {}, { - "description": "SSL certificate ID", - "name": "id", + "description": "certificate chain", + "name": "certchain", "type": "string" }, + {}, { "description": "name", "name": "name", "type": "string" }, - {}, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "certificate", - "name": "certificate", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, { - "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": "account for the certificate", - "name": "account", + "description": "certificate", + "name": "certificate", "type": "string" }, { "description": "the project id of the certificate", "name": "projectid", "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" } ] }, @@ -70407,102 +70407,102 @@ "name": "updateOauthProvider", "params": [ { - "description": "Client ID pre-registered in the specific OAuth provider", + "description": "OAuth provider will be enabled or disabled based on this value", "length": 255, - "name": "clientid", + "name": "enabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Redirect URI pre-registered in the specific OAuth provider", + "description": "Secret Key pre-registered in the specific OAuth provider", "length": 255, - "name": "redirecturi", + "name": "secretkey", "required": false, "type": "string" }, { - "description": "OAuth provider will be enabled or disabled based on this value", + "description": "Client ID pre-registered in the specific OAuth provider", "length": 255, - "name": "enabled", + "name": "clientid", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "id of the OAuth provider to be updated", + "description": "Description of the OAuth Provider", "length": 255, - "name": "id", - "related": "updateOauthProvider", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" }, { - "description": "Secret Key pre-registered in the specific OAuth provider", + "description": "Redirect URI pre-registered in the specific OAuth provider", "length": 255, - "name": "secretkey", + "name": "redirecturi", "required": false, "type": "string" }, { - "description": "Description of the OAuth Provider", + "description": "id of the OAuth provider to be updated", "length": 255, - "name": "description", - "required": false, - "type": "string" + "name": "id", + "related": "updateOauthProvider", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "Name of the provider", + "name": "provider", "type": "string" }, - {}, { - "description": "Name of the provider", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "Client ID registered in the OAuth provider", "name": "clientid", "type": "string" }, { - "description": "Description of the provider registered", - "name": "description", + "description": "Name of the provider", + "name": "name", "type": "string" }, - { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "type": "boolean" - }, { "description": "Secret key registered in the OAuth provider", "name": "secretkey", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description of the provider registered", + "name": "description", "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", + "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": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", + "type": "string" } ], "since": "4.19.0" @@ -70513,18 +70513,17 @@ "name": "createVpnCustomerGateway", "params": [ { - "description": "create site-to-site VPN customer gateway for the project", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "splitconnections", "required": false, - "since": "4.6", - "type": "uuid" + "since": "4.15.1", + "type": "boolean" }, { - "description": "ESP policy of the customer gateway", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "esppolicy", + "name": "ipsecpsk", "required": true, "type": "string" }, @@ -70536,31 +70535,31 @@ "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "public ip address id of the customer gateway", "length": 255, - "name": "cidrlist", + "name": "gateway", "required": true, "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "ipsecpsk", - "required": true, - "type": "string" + "name": "dpd", + "required": false, + "type": "boolean" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "esplifetime", + "name": "ikelifetime", "required": false, "type": "long" }, { - "description": "public ip address id of the customer gateway", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "gateway", - "required": true, + "name": "account", + "required": false, "type": "string" }, { @@ -70571,180 +70570,181 @@ "type": "boolean" }, { - "description": "If DPD is enabled for VPN connection", + "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": "dpd", + "name": "ikeversion", "required": false, - "type": "boolean" + "since": "4.15.1", + "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": "IKE policy of the customer gateway", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "name": "ikepolicy", + "required": true, + "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "create site-to-site VPN customer gateway for the project", "length": 255, - "name": "ikelifetime", + "name": "projectid", + "related": "createProject", "required": false, - "type": "long" + "since": "4.6", + "type": "uuid" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "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": "splitconnections", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "since": "4.15.1", - "type": "boolean" + "type": "uuid" }, { - "description": "IKE policy of the customer gateway", + "description": "ESP policy of the customer gateway", "length": 255, - "name": "ikepolicy", + "name": "esppolicy", "required": true, "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", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "ikeversion", + "name": "esplifetime", "required": false, - "since": "4.15.1", - "type": "string" + "type": "long" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "account", - "required": false, + "name": "cidrlist", + "required": true, "type": "string" } ], "related": "updateVpnCustomerGateway", "response": [ + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "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": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "name of the customer gateway", + "name": "name", + "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "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", + "type": "long" }, - {}, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the owner", - "name": "account", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, - { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" - }, { "description": "the domain id of the owner", "name": "domainid", "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "guest ip of the customer gateway", + "name": "ipaddress", + "type": "string" }, - {}, { - "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": "name of the customer gateway", - "name": "name", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", - "type": "string" + "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", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "IPsec policy of 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 project name", - "name": "project", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "the project id", - "name": "projectid", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + {}, + { + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the project name", + "name": "project", "type": "string" } ] @@ -70764,24 +70764,24 @@ ], "related": "addAnnotation,listAnnotations", "response": [ - { - "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" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "The username of the user that entered the annotation", + "name": "username", + "type": "string" + }, + { + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { @@ -70789,43 +70789,43 @@ "name": "userid", "type": "string" }, - {}, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, - {}, { - "description": "The username of the user that entered the annotation", - "name": "username", - "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 creation timestamp for this annotation", + "name": "created", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "type": "string" - } + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + {} ], "since": "4.11" }, @@ -70835,31 +70835,32 @@ "name": "addBaremetalHost", "params": [ { - "description": "list of tags to be added to the host", + "description": "the Zone ID for the host", "length": 255, - "name": "hosttags", - "required": false, - "type": "list" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "ip address intentionally allocated to this host after provisioning", + "description": "hypervisor type of the host", "length": 255, - "name": "ipaddress", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the cluster name for the host", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "clustername", + "name": "password", "required": false, "type": "string" }, { - "description": "hypervisor type of the host", + "description": "the cluster name for the host", "length": 255, - "name": "hypervisor", - "required": true, + "name": "clustername", + "required": false, "type": "string" }, { @@ -70871,41 +70872,40 @@ "type": "uuid" }, { - "description": "the Pod ID for the host", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "podid", - "related": "createPod,listPods,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "username", + "required": false, + "type": "string" }, { - "description": "the host URL", + "description": "ip address intentionally allocated to this host after provisioning", "length": 255, - "name": "url", - "required": true, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "the Pod ID for the host", "length": 255, - "name": "username", - "required": false, - "type": "string" + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "list of tags to be added to the host", "length": 255, - "name": "password", + "name": "hosttags", "required": false, - "type": "string" + "type": "list" }, { - "description": "the Zone ID for the host", + "description": "the host URL", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "url", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Allocation state of this Host for allocation of new resources", @@ -70918,38 +70918,124 @@ "related": "declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + {}, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "description": "the name of the host", - "name": "name", + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { @@ -70963,19 +71049,24 @@ "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "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", @@ -70983,34 +71074,29 @@ "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the Zone ID of the host", + "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 date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "GPU cards present in the host", @@ -71026,44 +71112,44 @@ "name": "vgpu", "response": [ { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "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 displays per user", - "name": "maxheads", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "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", + "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" } ], "type": "list" @@ -71072,29 +71158,29 @@ "type": "list" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { "description": "the admin that annotated this host", @@ -71102,211 +71188,125 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, + {}, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, { "description": "comma-separated list of implicit host tags for the host", "name": "implicithosttags", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "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 host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "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" }, { "description": "the management server ID of the host", "name": "managementserverid", "type": "string" }, - {}, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, { "description": "the amount of the host's CPU currently allocated in percentage", "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "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": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, - {}, { "description": "the host HA information information", "name": "hostha", "type": "hostharesponse" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the Pod ID of the host", - "name": "podid", - "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" } ] }, @@ -71330,23 +71330,23 @@ "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": "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" }, @@ -71366,27 +71366,27 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "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", - "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.9.0" }, @@ -71396,9 +71396,9 @@ "name": "updateVMSchedule", "params": [ { - "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": "Name of the schedule", "length": 255, - "name": "schedule", + "name": "description", "required": false, "type": "string" }, @@ -71410,11 +71410,12 @@ "type": "date" }, { - "description": "Enable VM schedule", + "description": "ID of VM schedule", "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" + "name": "id", + "related": "updateVMSchedule", + "required": true, + "type": "uuid" }, { "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", @@ -71424,9 +71425,9 @@ "type": "date" }, { - "description": "Name of the schedule", + "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": "description", + "name": "schedule", "required": false, "type": "string" }, @@ -71438,24 +71439,18 @@ "type": "string" }, { - "description": "ID of VM schedule", + "description": "Enable VM schedule", "length": 255, - "name": "id", - "related": "updateVMSchedule", - "required": true, - "type": "uuid" + "name": "enabled", + "required": false, + "type": "boolean" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "ID of virtual machine", + "name": "virtualmachineid", "type": "string" }, { @@ -71464,37 +71459,42 @@ "type": "string" }, { - "description": "Date when the schedule was created", - "name": "created", + "description": "Date after which the schedule becomes inactive", + "name": "enddate", "type": "date" }, { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, - {}, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "Cron formatted VM schedule", + "name": "schedule", + "type": "string" }, + {}, { "description": "the ID of VM schedule", "name": "id", "type": "string" }, { - "description": "Timezone of the schedule", - "name": "timezone", - "type": "string" + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, + { + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -71519,11 +71519,11 @@ "name": "listConfigurationGroups", "params": [ { - "description": "lists configuration group by group name", + "description": "", "length": 255, - "name": "group", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -71533,11 +71533,11 @@ "type": "integer" }, { - "description": "", + "description": "lists configuration group by group name", "length": 255, - "name": "page", + "name": "group", "required": false, - "type": "integer" + "type": "string" }, { "description": "List by keyword", @@ -71549,48 +71549,48 @@ ], "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 configuration group", "name": "description", "type": "string" }, { - "description": "the precedence of the configuration group", - "name": "precedence", - "type": "long" + "description": "the name of the configuration group", + "name": "name", + "type": "string" }, { "description": "the subgroups of the configuration group", "name": "subgroup", "response": [ - { - "description": "the name of the configuration subgroup", - "name": "name", - "type": "string" - }, { "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 name of the configuration group", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the precedence of the configuration group", + "name": "precedence", + "type": "long" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -71615,11 +71615,6 @@ "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", @@ -71631,6 +71626,11 @@ "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" } ] }, @@ -71647,14 +71647,6 @@ "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" - }, { "description": "id of the remote access vpn", "length": 255, @@ -71662,13 +71654,21 @@ "related": "createRemoteAccessVpn,listRemoteAccessVpns,updateRemoteAccessVpn", "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": "createRemoteAccessVpn,listRemoteAccessVpns", "response": [ { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { @@ -71676,35 +71676,29 @@ "name": "projectid", "type": "string" }, - { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", - "type": "string" - }, { "description": "the project name of the vpn", "name": "project", "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "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": "the ipsec preshared key", - "name": "presharedkey", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { @@ -71713,35 +71707,41 @@ "type": "integer" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the id of the remote access vpn", + "name": "id", + "type": "string" }, + {}, { "description": "the public ip address of the vpn server", "name": "publicip", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" } ], "since": "4.4" @@ -71755,19 +71755,11 @@ "description": "Comma separated list of UUIDs for volumes that will be deleted", "length": 255, "name": "volumeids", - "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, "since": "4.12.0", "type": "list" }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "type": "uuid" - }, { "description": "If true is passed, the vm is expunged immediately. False by default.", "length": 255, @@ -71775,505 +71767,92 @@ "required": false, "since": "4.2.1", "type": "boolean" - } - ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "response": [ + }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "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": "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": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "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": "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "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": "MTU configured on the NIC", - "name": "mtu", - "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": "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": "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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": "the traffic type of the nic", - "name": "traffictype", - "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "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 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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - } - ], - "type": "set" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "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": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, { "description": "true if the password rest feature is enabled, false otherwise", "name": "passwordenabled", "type": "boolean" }, { - "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", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - {}, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "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 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 name of the affinity group", - "name": "name", - "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": "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 project ID of the affinity group", - "name": "projectid", - "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 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 domain in which the virtual machine exists", - "name": "domainid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, { "description": "the VM's disk write in KiB", "name": "diskkbswrite", "type": "long" }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, { "description": "the ID of the availability zone for the virtual machine", "name": "zoneid", "type": "string" }, { - "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -72282,135 +71861,23 @@ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "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 name of the host for the virtual machine", "name": "hostname", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", - "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "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": "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": "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 domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "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", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { @@ -72418,107 +71885,22 @@ "name": "guestosid", "type": "string" }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "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 name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "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 write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, { "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 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", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -72532,8 +71914,13 @@ "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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" }, { @@ -72541,8 +71928,8 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -72551,28 +71938,28 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -72581,8 +71968,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -72591,28 +71978,23 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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 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", @@ -72621,43 +72003,23 @@ ], "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": "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 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", + "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", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -72670,33 +72032,33 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -72705,36 +72067,31 @@ "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": "the project name where tag belongs to", - "name": "project", + "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": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -72743,26 +72100,56 @@ "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "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 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 name of the security group", "name": "name", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -72770,13 +72157,23 @@ "name": "domainid", "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 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" }, { @@ -72785,8 +72182,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -72795,23 +72192,23 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -72820,13 +72217,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" } ], @@ -72836,513 +72233,379 @@ "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" } ], "type": "set" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the 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": "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - } - ] - }, - { - "description": "Starts a virtual machine.", - "isasync": true, - "name": "startVirtualMachine", - "params": [ + "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": "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": "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 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" + } + ], + "type": "set" + }, { - "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": "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": "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": "Boot into hardware setup menu or not", - "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", - "type": "boolean" - }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "type": "uuid" - }, - { - "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": "Deployment planner to use for vm allocation. Available to ROOT admin only", - "length": 255, - "name": "deploymentplanner", - "required": false, - "since": "4.4", - "type": "string" - } - ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "response": [ - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, - {}, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "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", + "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": "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 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 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" - } - ], - "type": "set" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the domain name of the security group", + "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", + "type": "string" + }, + { + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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 cidr of IPv6 network", + "name": "ip6cidr", + "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": "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": "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": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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 the ISO attached to the virtual machine", + "name": "isoid", + "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 project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "the ID of the security group", + "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": "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 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 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": "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" - }, - { - "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": "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": "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 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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the name of the affinity group", + "name": "name", + "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 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 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": "tag key name", - "name": "key", - "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 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" - } - ], - "type": "set" - }, - { - "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 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "type": "set" + "description": "the account owning the affinity group", + "name": "account", + "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 description of the affinity group", + "name": "description", + "type": "string" } ], "type": "set" }, { - "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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "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", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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.", - "name": "displayvm", - "type": "boolean" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -73351,49 +72614,49 @@ "type": "integer" }, { - "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": "device type of the root volume", - "name": "rootdevicetype", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the id of userdata used for the VM", + "name": "userdataid", "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": "the project name of the vm", - "name": "project", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { "description": "the name of the virtual machine", @@ -73401,93 +72664,109 @@ "type": "string" }, { - "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, + {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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 ISO attached to the virtual machine", - "name": "isodisplaytext", + "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 representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "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": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "User VM type", + "name": "vmtype", "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -73496,299 +72775,644 @@ "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": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "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": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "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", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "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", + "description": "the group name of the virtual machine", + "name": "group", "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 backup offering of the virtual machine", + "name": "backupofferingid", "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": "Starts a virtual machine.", + "isasync": true, + "name": "startVirtualMachine", + "params": [ + { + "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": "ssh key-pairs", - "name": "keypairs", - "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": "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 ID of the affinity group", - "name": "projectid", - "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 domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "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 name of the affinity group", - "name": "name", - "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" - } - ], - "type": "set" + "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": "the ID of the virtual machine", + "description": "The ID of the virtual machine", + "length": 255, "name": "id", - "type": "string" + "related": "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 name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "Boot into hardware setup menu or not", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "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": "the VM's primary IP address", - "name": "ipaddress", + "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, + } + ], + "related": "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": "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": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the state of the virtual machine", + "name": "state", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 list of resource tags associated", - "name": "tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "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 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", + "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 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": "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 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" + }, + { + "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 account owning the security group", + "name": "account", "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": "path of the Domain associated with the tag", + "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 ID of the security group", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "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 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": "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 list of resource tags associated with the rule", + "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 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": "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": "tag value", + "name": "value", + "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "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": "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 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 project name where tag belongs to", + "name": "project", + "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" } ], "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" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -73797,13 +73421,18 @@ "type": "boolean" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { @@ -73812,19 +73441,29 @@ "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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 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": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { "description": "VNF details", @@ -73832,23 +73471,88 @@ "type": "map" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "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": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the project id of the vm", - "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 state of the virtual machine", - "name": "state", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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 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": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -73856,28 +73560,18 @@ "name": "nic", "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -73886,43 +73580,43 @@ "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "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": "name of the vpc to which the nic belongs", - "name": "vpcname", - "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": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "name": "isdefault", + "type": "boolean" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -73930,6 +73624,11 @@ "name": "isolationuri", "type": "string" }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, { "description": "Id of the vm to which the nic belongs", "name": "virtualmachineid", @@ -73941,8 +73640,13 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -73950,83 +73654,379 @@ "name": "networkname", "type": "string" }, + { + "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": "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 gateway of the nic", - "name": "gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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", + "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 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 nic", + "name": "id", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, { "description": "Type of adapter if available", "name": "adaptertype", "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "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 IPv6 address of network", - "name": "ip6address", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ID of the affinity group", + "name": "id", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "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" + }, + { + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" } ], "type": "set" }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "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", + "type": "string" + }, { "description": "the id of userdata used for the VM", "name": "userdataid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "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 user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "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": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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 high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "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 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": "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": "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" } ] }, @@ -74052,11 +74052,14 @@ ], "related": "", "response": [ - {}, - {}, { - "description": "id of the resource", - "name": "resourceid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "base64 representation of resource icon", + "name": "base64image", "type": "string" }, { @@ -74064,21 +74067,18 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", "type": "resourceobjecttype" }, { - "description": "base64 representation of resource icon", - "name": "base64image", + "description": "id of the resource", + "name": "resourceid", "type": "string" - } + }, + {}, + {} ], "since": "4.16.0.0" }, @@ -74088,25 +74088,19 @@ "name": "createPod", "params": [ { - "description": "the name of the Pod", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the netmask for the Pod", + "description": "the ending IP address for the Pod", "length": 255, - "name": "netmask", + "name": "endip", "required": false, "type": "string" }, { - "description": "the ending IP address for the Pod", + "description": "the Zone ID in which the Pod will be created", "length": 255, - "name": "endip", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { "description": "the gateway for the Pod", @@ -74122,6 +74116,13 @@ "required": false, "type": "string" }, + { + "description": "the netmask for the Pod", + "length": 255, + "name": "netmask", + "required": false, + "type": "string" + }, { "description": "Allocation state of this Pod for allocation of new resources", "length": 255, @@ -74130,116 +74131,42 @@ "type": "string" }, { - "description": "the Zone ID in which the Pod will be created", + "description": "the name of the Pod", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" } ], "related": "listPods,createManagementNetworkIpRange", "response": [ { - "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": "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" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, - { - "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": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "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 ID of the Pod", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the name of the Pod", "name": "name", "type": "string" }, - { - "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 capacity of the Pod", "name": "capacity", "response": [ { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { @@ -74253,8 +74180,13 @@ "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", "type": "string" }, { @@ -74263,64 +74195,132 @@ "type": "long" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity name", + "name": "name", "type": "string" }, { "description": "the capacity type", "name": "type", "type": "short" - }, + } + ], + "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 Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ { - "description": "the Pod name", - "name": "podname", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the starting IP for the range", + "name": "startip", "type": "string" } ], "type": "list" }, + {}, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, + { + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", + "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 starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, - {} + { + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" + }, + { + "description": "the ID of the Pod", + "name": "id", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -74338,11 +74338,10 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -74353,12 +74352,13 @@ "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" - } + }, + {}, + {} ], "since": "4.6.0" }, @@ -74368,11 +74368,12 @@ "name": "provisionCertificate", "params": [ { - "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used", + "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", "length": 255, - "name": "reconnect", - "required": false, - "type": "boolean" + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" }, { "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", @@ -74382,36 +74383,35 @@ "type": "string" }, { - "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", + "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": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", - "required": true, - "type": "uuid" + "name": "reconnect", + "required": false, + "type": "boolean" } ], "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 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.11.0" @@ -74422,112 +74422,110 @@ "name": "listVirtualMachinesMetrics", "params": [ { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "userid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "displayvm", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the virtual machine", + "description": "the group ID", "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "name": "groupid", + "related": "updateInstanceGroup", "required": false, "type": "uuid" }, { - "description": "the availability zone ID", + "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": "zoneid", - "related": "listZones", + "name": "details", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "description": "the target hypervisor for the template", "length": 255, - "name": "name", + "name": "hypervisor", "required": false, "type": "string" }, { - "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 availability zone ID", "length": 255, - "name": "accumulate", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "uuid" }, { - "description": "flag to display the resource icon for VMs", + "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.16.0.0", + "since": "4.18.0.0", "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "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": "tags", + "name": "isvnf", "required": false, - "type": "map" + "since": "4.19.0", + "type": "boolean" }, { - "description": "", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "pagesize", + "name": "haenable", "required": false, - "type": "integer" + "since": "4.15", + "type": "boolean" }, { - "description": "list vms by vpc", + "description": "the host ID", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, "type": "uuid" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the cluster ID", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "showicon", "required": false, - "type": "uuid" + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "the pod ID", + "description": "", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the security group ID", @@ -74539,238 +74537,238 @@ "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 resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list by network id", + "description": "the pod ID", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "list by the backup offering", "length": 255, - "name": "ids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "name": "backupofferingid", "required": false, - "since": "4.4", - "type": "list" + "since": "4.17", + "type": "uuid" }, { - "description": "list vms by iso", + "description": "the cluster ID", "length": 255, - "name": "isoid", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "ids", + "related": "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" + "since": "4.4", + "type": "list" }, { - "description": "List by keyword", + "description": "list vms by template", "length": 255, - "name": "keyword", + "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": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list vms by affinity group", + "description": "list vms by ssh keypair name", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "keypair", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "retrieveonlyresourcecount", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list by the service offering", "length": 255, - "name": "account", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "string" + "since": "4.4", + "type": "uuid" }, { - "description": "", + "description": "list vms by vpc", "length": 255, - "name": "page", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the host ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "list by the service offering", + "description": "list vms by affinity group", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "list vms by ssh keypair name", + "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": "list vms by template", + "description": "the ID of the virtual machine", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "id", + "related": "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": "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.", + "description": "list vms by iso", "length": 255, - "name": "details", + "name": "isoid", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "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": "forvirtualnetwork", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the target hypervisor for the template", + "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": "hypervisor", + "name": "accumulate", "required": false, - "type": "string" + "since": "4.17.0", + "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "userdata", + "name": "tags", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "type": "map" }, { - "description": "the group ID", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "groupid", - "related": "updateInstanceGroup", + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, "type": "uuid" }, { - "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "isvnf", + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup", "required": false, - "since": "4.19.0", - "type": "boolean" + "since": "4.18.0", + "type": "uuid" }, { - "description": "list by the backup offering", + "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": "backupofferingid", + "name": "state", "required": false, - "since": "4.17", - "type": "uuid" + "type": "string" }, { - "description": "the ID of AutoScaling VM Group", + "description": "list by network id", "length": 255, - "name": "autoscalevmgroupid", - "related": "enableAutoScaleVmGroup", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "since": "4.18.0", "type": "uuid" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "haenable", + "name": "displayvm", "required": false, - "since": "4.15", + "since": "4.4", "type": "boolean" } ], "related": "listVirtualMachinesMetrics", "response": [ { - "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 VM's primary IP address", + "name": "ipaddress", "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": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "network write in MiB", - "name": "networkwrite", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { @@ -74779,68 +74777,48 @@ "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the total memory capacity in GiB", + "name": "memorytotal", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "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 received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { @@ -74849,172 +74827,84 @@ "type": "string" }, { - "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "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 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": "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": "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, - {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the project id of the vm", - "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 date when this virtual machine was updated last time", + "name": "lastupdated", + "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.", @@ -75022,68 +74912,48 @@ "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "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 project name of the vm", - "name": "project", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the user's name who deployed the virtual machine", + "name": "username", "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": "User VM type", - "name": "vmtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { @@ -75091,34 +74961,29 @@ "name": "affinitygroup", "response": [ { - "description": "the project name of the affinity group", - "name": "project", + "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 ID of the affinity group", - "name": "id", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "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 description of the affinity group", @@ -75131,367 +74996,98 @@ "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "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": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the type of the affinity group", - "name": "type", + "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" } ], "type": "set" }, - {}, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the total memory capacity in GiB", - "name": "memorytotal", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "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": "network read in MiB", - "name": "networkread", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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", + "type": "integer" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "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": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "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 list of nics associated with vm", - "name": "nic", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "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 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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the account owning the security group", + "name": "account", "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 vm to which the nic belongs", - "name": "virtualmachineid", - "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": "isdefault", - "type": "boolean" - }, - { - "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 traffic type of the nic", - "name": "traffictype", - "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 IPv6 address of network", - "name": "ip6address", - "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 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": "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 netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "disk read in MiB", - "name": "diskread", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "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 description of the security group", - "name": "description", - "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 list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "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", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -75500,18 +75096,23 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -75520,33 +75121,23 @@ "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", + "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", + "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", @@ -75558,13 +75149,18 @@ "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", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -75573,60 +75169,65 @@ "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "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 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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -75635,13 +75236,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -75663,81 +75264,36 @@ "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", + "description": "the name of the security group", + "name": "name", "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 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the 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": "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": "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", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -75745,119 +75301,563 @@ "name": "resourceid", "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", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "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", + "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" } ], "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the 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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "network write in MiB", + "name": "networkwrite", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "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 total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "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 name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "network read in MiB", + "name": "networkread", "type": "string" }, { "description": "the userdata override policy with the userdata provided while deploying VM", "name": "userdatapolicy", "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "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": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "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": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "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": "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": "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": "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 name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "disk read in MiB", + "name": "diskread", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "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 type of the nic", + "name": "type", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "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": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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 ip address of the nic", + "name": "ipaddress", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "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": "Type of adapter if available", + "name": "adaptertype", + "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" } ] }, @@ -75867,66 +75867,67 @@ "name": "listHosts", "params": [ { - "description": "List by keyword", + "description": "the host type", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" }, { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "the id of the host", "length": 255, - "name": "details", + "name": "id", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the host type", + "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", "length": 255, - "name": "type", + "name": "outofbandmanagementpowerstate", "required": false, "type": "string" }, { - "description": "", + "description": "the state of the host", "length": 255, - "name": "pagesize", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the name of the host", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "outofbandmanagementenabled", + "name": "details", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "resourcestate", + "name": "outofbandmanagementenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the state of the host", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "state", + "name": "hahost", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the Pod ID for the host", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "virtualmachineid", + "related": "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" }, @@ -75939,278 +75940,197 @@ "type": "uuid" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "hahost", + "name": "hypervisor", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the name of the host", + "description": "the Pod ID for the host", "length": 255, - "name": "name", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "", "length": 255, - "name": "hypervisor", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "List by keyword", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "keyword", "required": false, "type": "string" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the id of the host", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "id", - "related": "declareHostAsDegraded,listHosts,reconnectHost", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "lists hosts existing in particular cluster", + "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": "clusterid", - "related": "addCluster,updateCluster", + "name": "resourcestate", "required": false, - "type": "uuid" + "type": "string" } ], "related": "declareHostAsDegraded,reconnectHost", "response": [ { - "description": "events available for the host", - "name": "events", + "description": "the name of the host", + "name": "name", "type": "string" }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, { "description": "comma-separated list of explicit host tags for the host", "name": "explicithosttags", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the ID of the host", - "name": "id", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, { "description": "the state of the host", "name": "state", "type": "status" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum 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 Y resolution per display", - "name": "maxresolutiony", - "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" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "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 percentage", - "name": "memoryallocatedpercentage", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "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": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host type", + "name": "type", + "type": "type" }, { "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 CPU currently allocated after applying the cpu.overprovisioning.factor", "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { @@ -76219,14 +76139,9 @@ "type": "integer" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" - }, - { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { "description": "the date and time the host was removed", @@ -76234,75 +76149,81 @@ "type": "date" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", + "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 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 last annotation set on this host by an admin", - "name": "annotation", - "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 amount of the host's CPU currently used", - "name": "cpuused", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, + {}, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" }, - {}, { "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 amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { "description": "the date and time the host was last pinged", @@ -76310,79 +76231,158 @@ "type": "date" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, + { + "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 amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "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": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "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" + } + ], + "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": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the host version", + "name": "version", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" } ] }, @@ -76408,28 +76408,28 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "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" - } + {} ] }, { @@ -76447,18 +76447,16 @@ } ], "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": "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", @@ -76468,7 +76466,9 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {}, + {} ], "since": "4.17.0.0" }, @@ -76478,12 +76478,12 @@ "name": "updateStoragePool", "params": [ { - "description": "the details for the storage pool", + "description": "the Id of the storage pool", "length": 255, - "name": "details", - "required": false, - "since": "4.19.0", - "type": "map" + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" }, { "description": "bytes CloudStack can provision from this storage pool", @@ -76492,13 +76492,6 @@ "required": false, "type": "long" }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "length": 255, - "name": "istagarule", - "required": false, - "type": "boolean" - }, { "description": "comma-separated list of tags for the storage pool", "length": 255, @@ -76507,12 +76500,11 @@ "type": "list" }, { - "description": "Change the name of the storage pool", + "description": "the URL of the storage pool", "length": 255, - "name": "name", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "url", "required": false, - "since": "4.15", + "since": "4.19.0", "type": "string" }, { @@ -76523,27 +76515,35 @@ "type": "long" }, { - "description": "false to disable the pool for allocation of new volumes, true to enable it back.", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "enabled", + "name": "istagarule", "required": false, "type": "boolean" }, { - "description": "the Id of the storage pool", + "description": "the details for the storage pool", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" + "name": "details", + "required": false, + "since": "4.19.0", + "type": "map" }, { - "description": "the URL of the storage pool", + "description": "Change the name of the storage pool", "length": 255, - "name": "url", + "name": "name", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "since": "4.19.0", + "since": "4.15", "type": "string" + }, + { + "description": "false to disable the pool for allocation of new volumes, true to enable it back.", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", @@ -76555,14 +76555,19 @@ "type": "date" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { "description": "true if this pool is suitable to migrate a volume, false otherwise", @@ -76570,33 +76575,33 @@ "type": "boolean" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool type", + "name": "type", "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 storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -76605,13 +76610,28 @@ "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "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 Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { @@ -76619,96 +76639,76 @@ "name": "managed", "type": "boolean" }, - { - "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 host's currently allocated disk size", "name": "disksizeallocated", "type": "long" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { "description": "the state of the storage pool", "name": "state", "type": "storagepoolstatus" }, - { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" - }, {}, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" } ], "since": "3.0.0" @@ -76719,16 +76719,9 @@ "name": "listTungstenFabricTag", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the uuid of Tungsten-Fabric tag", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "taguuid", + "name": "policyuuid", "required": false, "type": "string" }, @@ -76747,102 +76740,109 @@ "type": "string" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "List by keyword", "length": 255, - "name": "applicationpolicysetuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "taguuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "networkuuid", + "name": "applicationpolicysetuuid", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "", "length": 255, - "name": "policyuuid", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric network", + "length": 255, + "name": "networkuuid", "required": false, "type": "string" } ], "related": "applyTungstenFabricTag", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" - }, { "description": "list Tungsten-Fabric policy", "name": "policy", "type": "list" }, + { + "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": "Tungsten-Fabric provider zone name", "name": "zonename", "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 tag type uuid", + "name": "uuid", + "type": "string" }, - {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, - {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" + }, + { + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" + }, + { + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" } ] }, @@ -76852,53 +76852,53 @@ "name": "importLdapUsers", "params": [ { - "description": "List by keyword", + "description": "Creates the account under the specified role.", "length": 255, - "name": "keyword", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "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": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "details for account used to store specific parameters", "length": 255, - "name": "account", + "name": "accountdetails", "required": false, - "type": "string" + "type": "map" }, { - "description": "", + "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": "page", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Creates the account under the specified role.", + "description": "List by keyword", "length": 255, - "name": "roleid", - "related": "createRole,listRoles,updateRole", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "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": "pagesize", + "name": "group", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", "length": 255, - "name": "timezone", + "name": "account", "required": false, "type": "string" }, @@ -76910,18 +76910,18 @@ "type": "integer" }, { - "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.", + "description": "", "length": 255, - "name": "group", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "details for account used to store specific parameters", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "accountdetails", + "name": "timezone", "required": false, - "type": "map" + "type": "string" } ], "related": "searchLdap", @@ -76932,14 +76932,19 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The user's email", + "name": "email", "type": "string" }, {}, { - "description": "The user's email", - "name": "email", + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", + "type": "string" + }, + { + "description": "The user's principle", + "name": "principal", "type": "string" }, { @@ -76947,14 +76952,15 @@ "name": "lastname", "type": "string" }, + {}, { "description": "The user's username", "name": "username", "type": "string" }, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -76962,17 +76968,11 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "The user's principle", - "name": "principal", - "type": "string" - }, { "description": "The user's firstname", "name": "firstname", "type": "string" - }, - {} + } ], "since": "4.3.0" }, @@ -76982,17 +76982,17 @@ "name": "moveDomain", "params": [ { - "description": "The ID of the domain to be moved.", + "description": "The ID of the new parent domain of the domain to be moved.", "length": 255, - "name": "domainid", + "name": "parentdomainid", "related": "createDomain,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" }, { - "description": "The ID of the new parent domain of the domain to be moved.", + "description": "The ID of the domain to be moved.", "length": 255, - "name": "parentdomainid", + "name": "domainid", "related": "createDomain,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" @@ -77000,44 +77000,24 @@ ], "related": "createDomain,listDomains,listDomains", "response": [ - { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the ID of the domain", - "name": "id", - "type": "string" - }, - { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" - }, { "description": "the total number of projects available for administration by this domain", "name": "projectavailable", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { @@ -77046,54 +77026,75 @@ "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "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 number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the path of the domain", + "name": "path", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" }, {}, + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" + }, + { + "description": "the ID of the domain", + "name": "id", + "type": "string" + }, { "description": "the total number of vpcs owned by domain", "name": "vpctotal", "type": "long" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of projects the domain 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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + {}, + { + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { @@ -77102,28 +77103,28 @@ "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { @@ -77137,79 +77138,64 @@ "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, - { - "description": "the path of the domain", - "name": "path", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", - "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 domain can acquire", @@ -77217,49 +77203,63 @@ "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, + { + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, { "description": "the total secondary storage space (in GiB) owned by domain", "name": "secondarystoragetotal", "type": "float" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, - {}, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" } ], @@ -77271,115 +77271,122 @@ "name": "listNetworks", "params": [ { - "description": "List networks by associated networks. Only available if create a Shared network.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "isrecursive", "required": false, - "since": "4.17.0", - "type": "uuid" + "type": "boolean" }, { - "description": "type of the traffic", + "description": "flag to display the resource icon for networks", "length": 255, - "name": "traffictype", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list networks by ID", + "description": "list networks by physical network id", "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "", + "description": "the zone ID of the network", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "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": "displaynetwork", + "name": "networkfilter", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.17.0", + "type": "string" }, { - "description": "list networks by physical network id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "displaynetwork", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "description": "list networks supporting certain services", "length": 255, - "name": "type", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the network belongs to VPC", "length": 255, - "name": "isrecursive", + "name": "forvpc", "required": false, "type": "boolean" }, { - "description": "list networks by restartRequired", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "restartrequired", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the network belongs to VPC", + "description": "list networks by ID", "length": 255, - "name": "forvpc", + "name": "id", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "type of the traffic", "length": 255, - "name": "account", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "true if network is system, false otherwise", + "description": "List by keyword", "length": 255, - "name": "issystem", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list networks by restartRequired", + "length": 255, + "name": "restartrequired", "required": false, "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "retrieveonlyresourcecount", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", + "description": "true if network is system, false otherwise", "length": 255, - "name": "acltype", + "name": "issystem", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list networks by network offering ID", @@ -77390,138 +77397,135 @@ "type": "uuid" }, { - "description": "the ID or VID of the network", + "description": "List networks by associated networks. Only available if create a Shared network.", "length": 255, - "name": "vlan", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "since": "4.17.0", - "type": "string" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "createProject", - "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": "List resources by tags (key/value pairs)", + "description": "List networks by VPC", "length": 255, - "name": "tags", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list networks supporting certain services", + "description": "list networks available for VM deployment", "length": 255, - "name": "supportedservices", + "name": "canusefordeploy", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "true if need to list only networks which support specifying IP ranges", + "description": "list networks by ACL (access control list) type. Supported values are account and domain", "length": 255, - "name": "specifyipranges", + "name": "acltype", "required": false, - "type": "boolean" + "type": "string" }, { - "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).", + "description": "the ID or VID of the network", "length": 255, - "name": "networkfilter", + "name": "vlan", "required": false, "since": "4.17.0", "type": "string" }, { - "description": "List networks by VPC", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "list networks available for VM deployment", + "description": "", "length": 255, - "name": "canusefordeploy", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "flag to display the resource icon for networks", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "showicon", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "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 zone ID of the network", + "description": "true if need to list only networks which support specifying IP ranges", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "specifyipranges", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "the type of the network. Supported values are: isolated, l2, shared and all", "length": 255, - "name": "pagesize", + "name": "type", "required": false, - "type": "integer" + "type": "string" } ], "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "response": [ { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, - {}, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { @@ -77530,29 +77534,24 @@ "type": "string" }, { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the name of the network", - "name": "name", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -77560,39 +77559,39 @@ "type": "integer" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "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 routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { "description": "the owner of the network", @@ -77600,237 +77599,160 @@ "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "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 type of the network", + "name": "type", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "ACL name associated with the VPC network", + "name": "aclname", "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 ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "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 external id of the network", + "name": "externalid", + "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "the date this network was created", + "name": "created", + "type": "date" }, + {}, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "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 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": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" }, - {}, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the list of resource tags associated with network", - "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 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 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" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { "description": "the list of services", @@ -77841,18 +77763,40 @@ "name": "name", "type": "string" }, + { + "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 service provider name", "name": "provider", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the provider name", + "name": "name", + "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -77861,14 +77805,14 @@ "type": "string" }, { - "description": "the provider name", - "name": "name", + "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": "true if individual services can be enabled/disabled", @@ -77876,31 +77820,9 @@ "type": "boolean" }, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" } ], "type": "list" @@ -77909,44 +77831,44 @@ "type": "list" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { "description": "an optional field, whether to the display the network to the end user or not.", @@ -77954,9 +77876,14 @@ "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 networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { "description": "network offering id the network is created from", @@ -77964,49 +77891,60 @@ "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "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 internet protocol of network offering", - "name": "internetprotocol", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + {}, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "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": "true if network is default, false otherwise", @@ -78014,9 +77952,71 @@ "type": "boolean" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "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 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": "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 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": "list" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" } ] }, @@ -78035,17 +78035,16 @@ } ], "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", @@ -78053,10 +78052,11 @@ }, {}, { - "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.17" }, @@ -78065,14 +78065,6 @@ "isasync": true, "name": "updatePodManagementNetworkIpRange", "params": [ - { - "description": "UUID of POD, where the IP range belongs to.", - "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, { "description": "The current starting IP address.", "length": 255, @@ -78096,6 +78088,14 @@ "required": true, "type": "string" }, + { + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, { "description": "The new ending IP address.", "length": 255, @@ -78105,28 +78105,28 @@ } ], "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" - }, - {} + } ], "since": "4.16.0.0" }, @@ -78136,103 +78136,149 @@ "name": "updateFirewallRule", "params": [ { - "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" }, { "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "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": "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" } ], "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", "response": [ + {}, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "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 domain associated with the tag", + "name": "domain", "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "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" } ], "type": "list" }, { - "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": "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 public ip address id for the firewall rule", @@ -78240,18 +78286,13 @@ "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { @@ -78260,52 +78301,11 @@ "type": "integer" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - } + {} ], "since": "4.4" }, @@ -78316,23 +78316,23 @@ "params": [], "related": "", "response": [ - {}, { "description": "is quota service enabled", "name": "isenabled", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.7.0" }, @@ -78352,27 +78352,27 @@ ], "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": "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.19.0" }, @@ -78382,18 +78382,18 @@ "name": "quotaEmailTemplateList", "params": [ { - "description": "List by keyword", + "description": "List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", "length": 255, - "name": "keyword", + "name": "templatetype", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -78403,15 +78403,21 @@ "type": "integer" }, { - "description": "List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", + "description": "", "length": 255, - "name": "templatetype", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ + { + "description": "The quota email template locale", + "name": "locale", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -78422,23 +78428,12 @@ "name": "jobid", "type": "string" }, - { - "description": "The quota email template content", - "name": "templatebody", - "type": "string" - }, - {}, - {}, { "description": "Template type", "name": "templatetype", "type": "string" }, - { - "description": "The quota email template locale", - "name": "locale", - "type": "string" - }, + {}, { "description": "The quota email template subject", "name": "templatesubject", @@ -78448,6 +78443,11 @@ "description": "Last date/time when template was updated", "name": "last_updated", "type": "date" + }, + { + "description": "The quota email template content", + "name": "templatebody", + "type": "string" } ], "since": "4.7.0" @@ -78458,34 +78458,25 @@ "name": "createBgpPeer", "params": [ { - "description": "BGP peer details in key/value pairs.", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "UUID of the zone which the Bgp Peer belongs to.", + "description": "The AS number of the Bgp Peer.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "asnumber", "required": true, - "type": "uuid" + "type": "long" }, { - "description": "project who will own the Bgp Peer", + "description": "The password of the Bgp Peer.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "password", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The AS number of the Bgp Peer.", + "description": "account who will own the Bgp Peer", "length": 255, - "name": "asnumber", - "required": true, - "type": "long" + "name": "account", + "required": false, + "type": "string" }, { "description": "The IPv4 address of the Bgp Peer.", @@ -78495,91 +78486,95 @@ "type": "string" }, { - "description": "domain ID of the account owning the Bgp Peer", + "description": "The IPv6 address of the Bgp Peer.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "ip6address", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The IPv6 address of the Bgp Peer.", + "description": "BGP peer details in key/value pairs.", "length": 255, - "name": "ip6address", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "account who will own the Bgp Peer", + "description": "project who will own the Bgp Peer", "length": 255, - "name": "account", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The password of the Bgp Peer.", + "description": "domain ID of the account owning the Bgp Peer", "length": 255, - "name": "password", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "UUID of the zone which the Bgp Peer belongs to.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "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": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" }, + {}, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "password of bgp peer", - "name": "password", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { @@ -78587,27 +78582,32 @@ "name": "domain", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "id of zone to which the bgp peer belongs to.", "name": "zoneid", "type": "string" }, - {}, { "description": "date when this bgp peer was created.", "name": "created", "type": "date" }, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", - "type": "string" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.20.0" }, @@ -78627,17 +78627,17 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "Hypervisor name", "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", @@ -78652,11 +78652,12 @@ "name": "dedicateBgpPeer", "params": [ { - "description": "account who will own the Bgp Peer", + "description": "domain ID of the account owning the Bgp Peer", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Id of the Bgp Peer", @@ -78667,84 +78668,89 @@ "type": "uuid" }, { - "description": "project who will own the Bgp Peer", + "description": "account who will own the Bgp Peer", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "domain ID of the account owning the Bgp Peer", + "description": "project who will own the Bgp Peer", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" } ], "related": "listBgpPeers,releaseBgpPeer", "response": [ + { + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "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 domain ID of the bgp peer", + "name": "domainid", + "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, {}, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "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", + "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": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, + {}, { - "description": "password of bgp peer", - "name": "password", - "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 bgp peer", - "name": "domainid", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { "description": "the domain name of the bgp peer", @@ -78752,19 +78758,13 @@ "type": "string" }, { - "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", + "description": "password of bgp peer", + "name": "password", "type": "string" }, - {}, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" } ], @@ -78776,11 +78776,18 @@ "name": "listHostsMetrics", "params": [ { - "description": "", + "description": "the state of the host", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "list hosts for which out-of-band management is enabled", + "length": 255, + "name": "outofbandmanagementenabled", + "required": false, + "type": "boolean" }, { "description": "the name of the host", @@ -78789,11 +78796,19 @@ "required": false, "type": "string" }, + { + "description": "the Zone ID for the host", + "length": 255, + "name": "zoneid", + "related": "listZones", + "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": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "related": "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" }, @@ -78804,21 +78819,6 @@ "required": false, "type": "list" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, { "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, @@ -78827,48 +78827,49 @@ "type": "string" }, { - "description": "", + "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": "pagesize", + "name": "outofbandmanagementpowerstate", "required": false, - "type": "integer" + "type": "string" }, { - "description": "lists hosts existing in particular cluster", + "description": "the id of the host", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "id", + "related": "declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, { - "description": "the state of the host", + "description": "", "length": 255, - "name": "state", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the id of the host", + "description": "the Pod ID for the host", "length": 255, - "name": "id", - "related": "declareHostAsDegraded,reconnectHost", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "the host type", "length": 255, - "name": "resourcestate", + "name": "type", "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": "lists hosts existing in particular cluster", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { "description": "if true, list only hosts dedicated to HA", @@ -78878,200 +78879,190 @@ "type": "boolean" }, { - "description": "the host type", + "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", "length": 255, - "name": "type", + "name": "resourcestate", "required": false, "type": "string" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "", "length": 255, - "name": "outofbandmanagementenabled", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the Pod ID for the host", + "description": "List by keyword", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "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 CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "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 amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "the total cpu used in Ghz", + "name": "cpuusedghz", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the total cpu capacity in Ghz", + "name": "cputotalghz", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "the total memory capacity in GiB", + "name": "memorytotalgb", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "instances on the host", - "name": "instances", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" + "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 last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "network write in GiB", - "name": "networkwrite", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocatedghz", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { "description": "CPU Arch of the host", "name": "arch", "type": "string" }, + {}, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "system vm instances on the host", + "name": "systeminstances", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotalgb", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "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 Pod ID of the host", - "name": "podid", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, { "description": "GPU cards present in the host", "name": "gpugroup", @@ -79085,11 +79076,26 @@ "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, { "description": "Maximum displays per user", "name": "maxheads", "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" + }, { "description": "Maximum Y resolution per display", "name": "maxresolutiony", @@ -79105,25 +79111,10 @@ "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 vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" } ], "type": "list" @@ -79131,205 +79122,200 @@ ], "type": "list" }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, { "description": "the CPU number of the host", "name": "cpunumber", "type": "integer" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "the average cpu load the last minute", + "name": "cpuloadaverage", + "type": "double" }, + {}, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "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 used", + "name": "cpuused", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { - "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 CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the average cpu load the last minute", - "name": "cpuloadaverage", - "type": "double" + "description": "out-of-band management power state", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the name of the host", - "name": "name", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "instances on the host", + "name": "instances", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "network write in GiB", + "name": "networkwrite", "type": "string" }, { - "description": "system vm instances on the host", - "name": "systeminstances", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "out-of-band management power state", - "name": "powerstate", - "type": "powerstate" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the total memory allocated in GiB", + "name": "memoryallocatedgb", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", - "type": "string" + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" }, - {}, { "description": "the state of the host", "name": "state", "type": "status" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the host version", - "name": "version", + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { @@ -79337,21 +79323,30 @@ "name": "ueficapability", "type": "boolean" }, - {}, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the total memory used in GiB", + "name": "memoryusedgb", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" }, { "description": "network read in GiB", @@ -79359,39 +79354,44 @@ "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "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" } ], "since": "4.9.3" @@ -79412,27 +79412,27 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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" + }, + {} ] }, { @@ -79441,68 +79441,76 @@ "name": "listAffinityGroups", "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.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "lists affinity groups by name", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists affinity groups by type", + "description": "", "length": 255, - "name": "type", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "lists affinity groups by name", + "description": "lists affinity groups by type", "length": 255, - "name": "name", + "name": "type", "required": false, "type": "string" }, { - "description": "", + "description": "list the affinity group by the ID provided", "length": 255, - "name": "page", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "lists affinity groups by virtual machine ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "virtualmachineid", + "related": "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": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "lists affinity groups by virtual machine ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, @@ -79514,84 +79522,76 @@ "type": "integer" }, { - "description": "list the affinity group by the ID provided", - "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", - "required": false, - "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" } ], "related": "createAffinityGroup", "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", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, + {}, { - "description": "the description of the affinity group", - "name": "description", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the description of the affinity group", + "name": "description", "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 project name of the affinity group", + "name": "project", + "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", @@ -79599,9 +79599,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ] }, @@ -79621,38 +79621,38 @@ ], "related": "prepareForShutdown,readyForShutdown", "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" + "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": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "long" }, { "description": "Indicates whether a shutdown has been triggered", "name": "shutdowntriggered", "type": "boolean" }, - { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" - } + {} ], "since": "4.19.0" }, @@ -79662,10 +79662,18 @@ "name": "registerSSHKeyPair", "params": [ { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, + "type": "uuid" + }, + { + "description": "Public key material of the keypair", + "length": 5120, + "name": "publickey", + "required": true, "type": "string" }, { @@ -79677,18 +79685,10 @@ "type": "uuid" }, { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" - }, - { - "description": "Public key material of the keypair", - "length": 5120, - "name": "publickey", - "required": true, "type": "string" }, { @@ -79702,11 +79702,15 @@ "related": "listSSHKeyPairs", "response": [ { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, - {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, {}, { "description": "Name of the keypair", @@ -79714,8 +79718,13 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the owner of the keypair", + "name": "account", + "type": "string" + }, + { + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { @@ -79724,13 +79733,13 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project id of the keypair owner", + "name": "projectid", + "type": "string" }, { - "description": "the owner of the keypair", - "name": "account", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, { @@ -79738,25 +79747,16 @@ "name": "domain", "type": "string" }, + {}, { - "description": "the project name of the keypair owner", - "name": "project", + "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 of the keypair owner", - "name": "domainid", - "type": "string" - }, - { - "description": "Fingerprint of the public key", - "name": "fingerprint", - "type": "string" } ] }, @@ -79773,14 +79773,6 @@ "required": false, "type": "uuid" }, - { - "description": "the ID of the project to reserve with this IP address", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" - }, { "description": "the ID of the public IP address to reserve", "length": 255, @@ -79790,72 +79782,120 @@ "type": "uuid" }, { - "description": "the account to reserve with this IP address", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "the ID of the project to reserve with this IP address", "length": 255, - "name": "fordisplay", + "name": "projectid", + "related": "createProject", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "the account to reserve with this IP address", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, - {}, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "the list of resource tags associated with ip address", + "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 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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "public IP address", + "name": "ipaddress", "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 public IP address 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" }, { @@ -79864,58 +79904,59 @@ "type": "string" }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", - "type": "boolean" + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "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", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", "type": "boolean" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" }, + {}, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, { - "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": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { @@ -79924,33 +79965,43 @@ "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "public IP address id", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the Network where ip belongs to", + "name": "networkname", "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": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -79959,106 +80010,55 @@ "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "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": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "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 Network where ip belongs to", - "name": "networkid", - "type": "string" + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" + "description": "public IP address id", + "name": "id", + "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 name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", + "description": "is public ip for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the list of resource tags associated with ip address", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "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 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" - } - ], - "type": "list" + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" + }, + { + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", + "type": "string" } ], "since": "4.17" @@ -80099,28 +80099,28 @@ } ], "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - {} + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { @@ -80132,7 +80132,7 @@ "description": "the ID of the ISO file", "length": 255, "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "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" }, @@ -80146,12 +80146,17 @@ } ], "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", @@ -80162,12 +80167,7 @@ "name": "success", "type": "boolean" }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ] }, { @@ -80176,58 +80176,58 @@ "name": "listVPCOfferings", "params": [ { - "description": "list VPC offerings by id", + "description": "id of zone VPC offering is associated with", "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", + "name": "zoneid", + "related": "listZones", "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "true if need to list only default VPC offerings. Default value is false", + "description": "list VPC offerings supporting certain services", "length": 255, - "name": "isdefault", + "name": "supportedservices", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "", + "description": "true if need to list only default VPC offerings. Default value is false", "length": 255, - "name": "pagesize", + "name": "isdefault", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list VPC offerings available for VPC creation in specific domain", + "description": "list VPC offerings by id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", "required": false, - "since": "4.18", "type": "uuid" }, { - "description": "list VPC offerings by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "id of zone VPC offering is associated with", + "description": "list VPC offerings available for VPC creation in specific domain", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.13", + "since": "4.18", "type": "uuid" }, { - "description": "list VPC offerings by display text", + "description": "", "length": 255, - "name": "displaytext", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "list VPC offerings by name", @@ -80237,173 +80237,142 @@ "type": "string" }, { - "description": "", + "description": "list VPC offerings by state", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list VPC offerings supporting certain services", + "description": "list VPC offerings by display text", "length": 255, - "name": "supportedservices", + "name": "displaytext", "required": false, - "type": "list" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "updateVPCOffering", "response": [ { - "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": "the name of the vpc offering", + "name": "name", "type": "string" }, - { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" - }, { "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", "name": "distributedvpcrouter", "type": "boolean" }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", - "type": "string" - }, { "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": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "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", + "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", + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", "type": "boolean" }, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "the name of the vpc offering", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the list of supported services", "name": "service", "response": [ { - "description": "the list of capabilities", - "name": "capability", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "the capability value", - "name": "value", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" }, - { - "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 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": "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": "state of the network provider", "name": "state", "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" @@ -80414,24 +80383,55 @@ "type": "string" }, { - "description": "true if vpc offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", "type": "boolean" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" + }, + { + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "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": "an alternate display text of the vpc offering.", + "name": "displaytext", "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": "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 supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" } ] }, @@ -80450,7 +80450,11 @@ ], "related": "", "response": [ - {}, + { + "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", + "name": "solidFireVolumeSize", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -80461,11 +80465,7 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", - "name": "solidFireVolumeSize", - "type": "long" - }, + {}, {} ] }, @@ -80475,33 +80475,24 @@ "name": "uploadVolume", "params": [ { - "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, - "type": "string" - }, - { - "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 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": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Upload volume for the project", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Image store uuid", - "length": 255, - "name": "imagestoreuuid", - "required": false, + "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { @@ -80513,24 +80504,24 @@ "type": "uuid" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "account", - "required": false, + "name": "format", + "required": true, "type": "string" }, { - "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, + "description": "Image store uuid", + "length": 255, + "name": "imagestoreuuid", + "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": "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": "diskofferingid", - "related": "", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, @@ -80542,308 +80533,269 @@ "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": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", "length": 255, - "name": "checksum", + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "Upload volume for the project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" } ], - "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "name of the virtual machine", - "name": "vmname", + "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": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, + {}, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "name of the disk offering", + "name": "diskofferingname", "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 date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "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", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "cluster id of the volume", + "name": "clusterid", "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": "tag key name", - "name": "key", - "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": "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": "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 display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "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": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "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": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "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", + "type": "string" }, - {}, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { "description": "details for the volume check result, they may vary for different hypervisors", @@ -80851,98 +80803,156 @@ "type": "map" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the bytes allocated", + "name": "virtualsize", + "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": "name of the availability zone", - "name": "zonename", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "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 bytes actually consumed on disk", - "name": "physicalsize", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, + {}, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "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 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": "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" + } + ], + "type": "set" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { @@ -80951,29 +80961,19 @@ "type": "string" }, { - "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 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 ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "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": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "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" } ] }, @@ -80983,24 +80983,23 @@ "name": "configureOutOfBandManagement", "params": [ { - "description": "the ID of the host", + "description": "the host management interface password", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the host management interface driver, for example: ipmitool", + "description": "the host management interface user", "length": 255, - "name": "driver", + "name": "username", "required": true, "type": "string" }, { - "description": "the host management interface user", + "description": "the host management interface driver, for example: ipmitool", "length": 255, - "name": "username", + "name": "driver", "required": true, "type": "string" }, @@ -81012,16 +81011,17 @@ "type": "string" }, { - "description": "the host management interface IP address", + "description": "the ID of the host", "length": 255, - "name": "address", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the host management interface password", + "description": "the host management interface IP address", "length": 255, - "name": "password", + "name": "address", "required": true, "type": "string" } @@ -81029,31 +81029,25 @@ "related": "enableOutOfBandManagementForHost,changeOutOfBandManagementPassword", "response": [ { - "description": "the out-of-band management interface password", - "name": "password", + "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" - }, - {}, - { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - {}, { "description": "the operation result", "name": "status", "type": "boolean" }, + {}, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { "description": "the out-of-band management driver for the host", @@ -81061,29 +81055,24 @@ "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", + "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": "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", + "description": "the out-of-band management interface username", + "name": "username", "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 interface port", @@ -81091,8 +81080,19 @@ "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "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": "the operation result description", + "name": "description", "type": "string" } ], @@ -81106,14 +81106,14 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -81127,12 +81127,6 @@ ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the ID of the storage tag", "name": "id", @@ -81143,17 +81137,23 @@ "name": "poolid", "type": "long" }, + {}, { - "description": "the name of the storage tag", - "name": "name", + "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 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" + } ] }, { @@ -81165,7 +81165,7 @@ "description": "ID of VM", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "related": "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" }, @@ -81187,17 +81187,17 @@ } ], "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", @@ -81205,9 +81205,9 @@ }, {}, { - "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" @@ -81217,6 +81217,13 @@ "isasync": true, "name": "createIpv4SubnetForGuestNetwork", "params": [ + { + "description": "The CIDR of this Ipv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, + "type": "string" + }, { "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", "length": 255, @@ -81231,82 +81238,70 @@ "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "required": true, "type": "uuid" - }, - { - "description": "The CIDR of this Ipv4 subnet.", - "length": 255, - "name": "subnet", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "id of the data center IPv4 subnet", - "name": "parentid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" }, { - "description": "subnet of the IPv4 network", - "name": "subnet", + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "id of the data center IPv4 subnet", + "name": "parentid", "type": "string" }, { - "description": "id of network which the IPv4 subnet is associated with.", - "name": "networkid", + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", "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 removed.", + "name": "removed", + "type": "date" }, { - "description": "id of the IPv4 subnet for guest network", - "name": "id", + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" - }, - { - "description": "date when this IPv4 subnet was removed.", - "name": "removed", - "type": "date" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "Id of the VPC which the IPv4 subnet is associated with.", - "name": "vpcid", + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", "type": "string" }, + {}, { - "description": "subnet of the data center IPv4 subnet", - "name": "parentsubnet", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { @@ -81315,13 +81310,18 @@ "type": "date" }, { - "description": "state of subnet of the IPv4 network", - "name": "state", + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "id of the IPv4 subnet for guest network", + "name": "id", "type": "string" }, { - "description": "Name of the VPC which the IPv4 subnet is associated with.", - "name": "vpcname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -81344,26 +81344,15 @@ "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", "response": [ { - "description": "the template ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the list of projects the template is available for", - "name": "projectids", - "type": "list" - }, { "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": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -81374,11 +81363,22 @@ "name": "domainid", "type": "string" }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + {}, {}, { "description": "the list of accounts the template is available for", "name": "account", "type": "list" + }, + { + "description": "the list of projects the template is available for", + "name": "projectids", + "type": "list" } ] }, @@ -81396,46 +81396,46 @@ "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "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", + "description": "the entity type", "length": 255, - "name": "annotationfilter", + "name": "entitytype", "required": false, - "since": "4.16.0", "type": "string" }, { - "description": "the id of the annotation", + "description": "", "length": 255, - "name": "id", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "the id of the annotation", "length": 255, - "name": "keyword", + "name": "id", "required": false, "type": "string" }, { - "description": "the entity type", + "description": "the id of the entity for which to show annotations", "length": 255, - "name": "entitytype", + "name": "entityid", "required": false, "type": "string" }, { - "description": "the id of the entity for which to show annotations", + "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": "entityid", + "name": "annotationfilter", "required": false, + "since": "4.16.0", "type": "string" }, { @@ -81449,18 +81449,13 @@ "related": "addAnnotation", "response": [ { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { @@ -81473,35 +81468,35 @@ "name": "annotation", "type": "string" }, - {}, - { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", - "type": "string" - }, - { - "description": "the type of the annotated entity", - "name": "entitytype", - "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", - "type": "date" + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { @@ -81509,6 +81504,11 @@ "name": "entityid", "type": "string" }, + { + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, {} ], "since": "4.11" @@ -81518,6 +81518,13 @@ "isasync": false, "name": "addSwift", "params": [ + { + "description": "the URL for swift", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, { "description": "the account for swift", "length": 255, @@ -81538,45 +81545,24 @@ "name": "key", "required": false, "type": "string" - }, - { - "description": "the URL for swift", - "length": 255, - "name": "url", - "required": true, - "type": "string" } ], "related": "addSecondaryStorage,listSwifts,addImageStore", "response": [ { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, + {}, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - { - "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 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 of the image store", - "name": "zoneid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { @@ -81584,41 +81570,55 @@ "name": "url", "type": "string" }, + {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "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", + "type": "string" + }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" }, { "description": "the Zone name of the image store", "name": "zonename", "type": "string" }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, { "description": "the scope of the image store", "name": "scope", "type": "scopetype" }, - {}, { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "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" }, - {}, { - "description": "the ID of the image store", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the image store", + "name": "name", "type": "string" } ], @@ -81629,14 +81629,6 @@ "isasync": false, "name": "listSnapshotPolicies", "params": [ - { - "description": "the ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -81644,13 +81636,6 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the ID of the snapshot policy", "length": 255, @@ -81666,6 +81651,13 @@ "required": false, "type": "integer" }, + { + "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, @@ -81673,10 +81665,28 @@ "required": false, "since": "4.4", "type": "boolean" + }, + { + "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" } ], "related": "updateSnapshotPolicy", "response": [ + { + "description": "the ID of the snapshot policy", + "name": "id", + "type": "string" + }, + { + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, { "description": "the list of resource tags associated", "name": "tags", @@ -81687,8 +81697,13 @@ "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" }, { @@ -81697,13 +81712,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -81712,36 +81727,36 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "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": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" + }, + { + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { @@ -81750,16 +81765,21 @@ "type": "boolean" }, {}, + { + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -81770,31 +81790,11 @@ "name": "schedule", "type": "string" }, - { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" - }, - { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, + {}, { "description": "maximum number of snapshots retained", "name": "maxsnaps", "type": "int" - }, - {}, - { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" } ] }, @@ -81803,6 +81803,13 @@ "isasync": true, "name": "updateVpnCustomerGateway", "params": [ + { + "description": "If DPD is enabled for VPN connection", + "length": 255, + "name": "dpd", + "required": false, + "type": "boolean" + }, { "description": "name of this customer gateway", "length": 255, @@ -81811,54 +81818,45 @@ "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", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "ikeversion", + "name": "splitconnections", "required": false, "since": "4.15.1", - "type": "string" + "type": "boolean" }, { - "description": "IKE policy of the customer gateway", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "ikepolicy", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "Force encapsulation for Nat Traversal", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "forceencap", + "name": "esplifetime", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "id of customer gateway", + "description": "ESP policy of the customer gateway", "length": 255, - "name": "id", - "related": "updateVpnCustomerGateway", + "name": "esppolicy", "required": true, - "type": "uuid" - }, - { - "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" + "type": "string" }, { - "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "cidrlist", + "name": "ipsecpsk", "required": true, "type": "string" }, { - "description": "ESP policy of the customer gateway", + "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "esppolicy", + "name": "cidrlist", "required": true, "type": "string" }, @@ -81870,38 +81868,26 @@ "type": "long" }, { - "description": "If DPD is enabled for VPN connection", - "length": 255, - "name": "dpd", - "required": false, - "type": "boolean" - }, - { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "account", - "required": false, + "name": "ikepolicy", + "required": true, "type": "string" }, { - "description": "public ip address id of the customer gateway", + "description": "id of customer gateway", "length": 255, - "name": "gateway", + "name": "id", + "related": "updateVpnCustomerGateway", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "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": "esplifetime", + "name": "ikeversion", "required": false, - "type": "long" - }, - { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", - "length": 255, - "name": "ipsecpsk", - "required": true, + "since": "4.15.1", "type": "string" }, { @@ -81911,53 +81897,83 @@ "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" + }, + { + "description": "Force encapsulation for Nat Traversal", + "length": 255, + "name": "forceencap", + "required": false, + "type": "boolean" + }, + { + "description": "public ip address id of the customer gateway", + "length": 255, + "name": "gateway", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the vpn gateway ID", - "name": "id", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, + {}, { "description": "guest ip of the customer gateway", "name": "ipaddress", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "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": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, { - "description": "name of the customer gateway", - "name": "name", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { @@ -81965,57 +81981,36 @@ "name": "account", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "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", + "description": "the project name", + "name": "project", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", "type": "long" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "the domain path of the owner", @@ -82023,9 +82018,9 @@ "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", + "type": "string" }, { "description": "the domain id of the owner", @@ -82033,9 +82028,14 @@ "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": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" } ] }, @@ -82045,52 +82045,52 @@ "name": "applyTungstenFabricTag", "params": [ { - "description": "the uuid of networks", + "description": "the uuid of vms", "length": 255, - "name": "networkuuid", + "name": "vmuuid", "required": false, "type": "list" }, { - "description": "the ID of zone", + "description": "the uuid of nics", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "nicuuid", + "required": false, + "type": "list" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "the uuid of networks", "length": 255, - "name": "taguuid", - "required": true, - "type": "string" + "name": "networkuuid", + "required": false, + "type": "list" }, { - "description": "the uuid of nics", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "nicuuid", + "name": "policyuuid", "required": false, - "type": "list" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "applicationpolicysetuuid", - "required": false, + "name": "taguuid", + "required": true, "type": "string" }, { - "description": "the uuid of vms", + "description": "the ID of zone", "length": 255, - "name": "vmuuid", - "required": false, - "type": "list" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "policyuuid", + "name": "applicationpolicysetuuid", "required": false, "type": "string" } @@ -82104,34 +82104,29 @@ "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "list Tungsten-Fabric network", - "name": "network", + "description": "list Tungsten-Fabric nic", + "name": "nic", "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", + "description": "list Tungsten-Fabric network", + "name": "network", "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" }, { "description": "Tungsten-Fabric provider zone name", @@ -82143,12 +82138,17 @@ "name": "policy", "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ] }, { @@ -82156,13 +82156,6 @@ "isasync": false, "name": "updateObjectStoragePool", "params": [ - { - "description": "the url for the object store", - "length": 255, - "name": "url", - "required": false, - "type": "string" - }, { "description": "Object Store ID", "length": 255, @@ -82177,13 +82170,36 @@ "name": "name", "required": false, "type": "string" + }, + { + "description": "the url for the object store", + "length": 255, + "name": "url", + "required": false, + "type": "string" } ], "related": "addObjectStoragePool", "response": [ { - "description": "the url of the object store", - "name": "url", + "description": "the name of the object store", + "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 object store", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -82196,6 +82212,12 @@ "name": "providername", "type": "string" }, + {}, + { + "description": "the url of the object store", + "name": "url", + "type": "string" + }, { "description": "the total size of the object store", "name": "storagetotal", @@ -82205,28 +82227,6 @@ "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": "the name of the object store", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the object store", - "name": "id", - "type": "string" } ], "since": "4.19.0" @@ -82255,68 +82255,63 @@ "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "response": [ { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "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 cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "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 id of the account", - "name": "id", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the state of the account", + "name": "state", + "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { @@ -82324,141 +82319,80 @@ "name": "icon", "type": "resourceiconresponse" }, - { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, { "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 name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, - { - "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", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the network domain", + "name": "networkdomain", "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 account", - "name": "vmtotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, - {}, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "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 owned by account", - "name": "cputotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { "description": "the name of the account", "name": "name", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "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 available for administration by this account", - "name": "projectavailable", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { @@ -82466,14 +82400,19 @@ "name": "user", "response": [ { - "description": "the user email address", - "name": "email", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the user firstname", @@ -82485,45 +82424,60 @@ "name": "secretkey", "type": "string" }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, { "description": "the timezone user was created in", "name": "timezone", "type": "string" }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "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 date and time the user account was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "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": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { "description": "the user state", @@ -82531,38 +82485,23 @@ "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", + "description": "the user lastname", + "name": "lastname", "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 type of the role", - "name": "roletype", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -82571,31 +82510,26 @@ "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the domain name of the user", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { @@ -82604,43 +82538,69 @@ "type": "long" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "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", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { "description": "The tagged resource limit and count for the account", "name": "taggedresources", "type": "list" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "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": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, { "description": "the total number of virtual machines running for this account", "name": "vmrunning", "type": "integer" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the id of the account", + "name": "id", + "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { @@ -82649,44 +82609,84 @@ "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 primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "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 state of the account", - "name": "state", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "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 templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" } ] }, @@ -82695,13 +82695,6 @@ "isasync": true, "name": "stopRouter", "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 router", "length": 255, @@ -82709,62 +82702,44 @@ "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "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": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "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 list of nics associated with the router", "name": "nic", "response": [ { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "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", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -82773,38 +82748,28 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -82813,14 +82778,14 @@ "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "IP addresses associated with NIC found for unmanaged VM", @@ -82828,74 +82793,84 @@ "type": "list" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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", + "description": "Type of adapter if available", + "name": "adaptertype", "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" } ], "type": "set" @@ -82906,19 +82881,18 @@ "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the version of template", + "name": "version", "type": "string" }, - {}, { - "description": "role of the domain router", - "name": "role", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { @@ -82927,83 +82901,85 @@ "type": "boolean" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, + {}, { - "description": "the first DNS for the router", - "name": "dns1", - "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": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, + {}, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the Pod name for the router", + "name": "podname", + "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -83012,156 +82988,165 @@ "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "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": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" }, { - "description": "the id of the router", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "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", + "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "role of the domain router", + "name": "role", "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 type of the health check - basic or advanced", "name": "checktype", "type": "string" }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, { "description": "result of the health check", "name": "success", "type": "boolean" }, + { + "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": "detailed response generated on running health check", + "name": "details", + "type": "string" } ], "type": "list" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the host ID for the router", + "name": "hostid", + "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "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", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "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": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { @@ -83170,13 +83155,28 @@ "type": "state" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" } ] @@ -83196,28 +83196,28 @@ } ], "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": "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": "3.0.0" }, @@ -83258,16 +83258,15 @@ ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" }, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, {}, { @@ -83275,14 +83274,15 @@ "name": "uuid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric firewall policy name", + "name": "name", "type": "string" }, { @@ -83291,10 +83291,10 @@ "type": "integer" }, { - "description": "list Tungsten-Fabric firewall rule", - "name": "firewallrule", - "type": "list" - } + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + } ] }, { @@ -83303,11 +83303,11 @@ "name": "updateRegion", "params": [ { - "description": "updates region with this name", + "description": "Id of region to update", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "id", + "required": true, + "type": "integer" }, { "description": "updates region with this end point", @@ -83317,24 +83317,20 @@ "type": "string" }, { - "description": "Id of region to update", + "description": "updates region with this name", "length": 255, - "name": "id", - "required": true, - "type": "integer" + "name": "name", + "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 ID of the region", - "name": "id", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the name of the region", @@ -83342,27 +83338,31 @@ "type": "string" }, { - "description": "the end point of the region", - "name": "endpoint", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the ID of the region", + "name": "id", + "type": "integer" }, { "description": "true if security groups support is enabled, false otherwise", "name": "portableipserviceenabled", "type": "boolean" }, + {}, + { + "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 GSLB service is enabled in the region, false otherwise", "name": "gslbserviceenabled", "type": "boolean" - }, - {} + } ] }, { @@ -83380,28 +83380,28 @@ } ], "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "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" }, @@ -83410,14 +83410,6 @@ "isasync": true, "name": "destroySharedFileSystem", "params": [ - { - "description": "the ID of the shared filesystem to delete", - "length": 255, - "name": "id", - "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "required": false, - "type": "uuid" - }, { "description": "If true is passed, the shared filesystem is expunged immediately. False by default.", "length": 255, @@ -83431,30 +83423,38 @@ "name": "forced", "required": false, "type": "boolean" + }, + { + "description": "the ID of the shared filesystem to delete", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": false, + "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": "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.20.0" @@ -83484,8 +83484,8 @@ "related": "", "response": [ { - "description": "the ID of the project", - "name": "projectid", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { @@ -83494,13 +83494,13 @@ "type": "integer" }, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" }, { @@ -83514,22 +83514,22 @@ "name": "jobid", "type": "string" }, - { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", - "type": "string" - }, { "description": "the api name or wildcard rule", "name": "rule", "type": "string" }, + {}, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the description of the role permission", + "name": "description", "type": "string" }, - {} + { + "description": "the ID of the project", + "name": "projectid", + "type": "string" + } ], "since": "4.15.0" }, @@ -83539,12 +83539,12 @@ "name": "listLdapConfigurations", "params": [ { - "description": "linked domain", + "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "listall", "required": false, - "type": "uuid" + "since": "4.13.2", + "type": "boolean" }, { "description": "", @@ -83554,16 +83554,9 @@ "type": "integer" }, { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "Port", "length": 255, - "name": "pagesize", + "name": "port", "required": false, "type": "integer" }, @@ -83575,49 +83568,56 @@ "type": "string" }, { - "description": "Port", + "description": "", "length": 255, - "name": "port", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", + "description": "linked domain", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "uuid" + }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" } ], "related": "addLdapConfiguration", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "name of the host running the ldap server", "name": "hostname", "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", "type": "string" }, - {}, { "description": "linked domain", "name": "domainid", "type": "string" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "port the ldap server is running on", + "name": "port", + "type": "int" } ], "since": "4.2.0" @@ -83628,10 +83628,11 @@ "name": "createRemoteAccessVpn", "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", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "openfirewall", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { @@ -83642,28 +83643,19 @@ "type": "string" }, { - "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", + "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": "createDomain,listDomains,listDomains", + "name": "iprange", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "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": "fordisplay", + "name": "openfirewall", "required": false, - "since": "4.4", "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": "public ip address id of the vpn server", "length": 255, @@ -83671,6 +83663,14 @@ "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "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,listDomains,listDomains", + "required": false, + "type": "uuid" } ], "related": "listRemoteAccessVpns", @@ -83685,6 +83685,13 @@ "name": "account", "type": "string" }, + {}, + { + "description": "the ipsec preshared key", + "name": "presharedkey", + "type": "string" + }, + {}, { "description": "the public ip address of the vpn server", "name": "publicip", @@ -83696,8 +83703,8 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { @@ -83710,46 +83717,39 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, - {}, { "description": "the project name of the vpn", "name": "project", "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" } ] @@ -83775,14 +83775,6 @@ "required": true, "type": "uuid" }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "type": "uuid" - }, { "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, @@ -83790,6 +83782,14 @@ "required": false, "type": "map" }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "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": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, @@ -83815,31 +83815,26 @@ "type": "boolean" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "related": "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 control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, { "description": "the ID of the ISO attached to the virtual machine", "name": "isoid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -83848,33 +83843,49 @@ "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "device type of the root volume", + "name": "rootdevicetype", "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "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": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, + {}, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "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": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -83882,18 +83893,13 @@ "name": "affinitygroup", "response": [ { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { @@ -83902,8 +83908,8 @@ "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { @@ -83917,13 +83923,13 @@ "type": "list" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { @@ -83932,83 +83938,103 @@ "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "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 ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the VM's primary IP address", - "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": "ssh key-pairs", - "name": "keypairs", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "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", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "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": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { "description": "the group name of the virtual machine", @@ -84016,72 +84042,78 @@ "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "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 ID of the virtual machine", - "name": "groupid", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "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": "User VM type", + "name": "vmtype", "type": "string" }, + {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "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": "OS name of the vm", - "name": "osdisplayname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, { "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": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -84095,18 +84127,18 @@ "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": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -84115,124 +84147,198 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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 name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "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 id of userdata used for the VM", "name": "userdataid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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 VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", "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": "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 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": "security group name", "name": "securitygroupname", "type": "string" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -84241,52 +84347,82 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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" + }, + { + "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 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" @@ -84297,20 +84433,87 @@ "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "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": "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": "tag key name", + "name": "key", + "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": "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" + } + ], + "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 id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", @@ -84322,32 +84525,32 @@ "type": "string" }, { - "description": "the account owning the security group", - "name": "account", - "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 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": "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", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -84361,13 +84564,8 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -84385,18 +84583,23 @@ "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -84405,354 +84608,111 @@ "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": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 id of the security group rule", - "name": "ruleid", + "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" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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 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 list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" - } - ], - "type": "set" - }, - { - "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "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 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", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "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 user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - {}, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "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 vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ + }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -84761,24 +84721,9 @@ "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": "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" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { "description": "the ID of the corresponding network", @@ -84791,13 +84736,8 @@ "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -84806,8 +84746,13 @@ "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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" }, { @@ -84816,44 +84761,49 @@ "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "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": "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", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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 gateway of IPv6 network", @@ -84861,28 +84811,23 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "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 netmask of the nic", - "name": "netmask", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -84891,22 +84836,77 @@ "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, + { + "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": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, { "description": "the project name of the vm", "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 name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" } ] }, @@ -84916,18 +84916,11 @@ "name": "listGuestOsMapping", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list Guest OS mapping by OS mapping name with hypervisor", + "description": "", "length": 255, - "name": "osnameforhypervisor", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "list mapping by its UUID", @@ -84938,40 +84931,47 @@ "type": "uuid" }, { - "description": "list Guest OS mapping by OS display name", + "description": "", "length": 255, - "name": "osdisplayname", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list Guest OS mapping by OS mapping name with hypervisor", + "length": 255, + "name": "osnameforhypervisor", "required": false, "type": "string" }, { - "description": "list Guest OS mapping by hypervisor", + "description": "list Guest OS mapping by OS display name", "length": 255, - "name": "hypervisor", + "name": "osdisplayname", "required": false, "type": "string" }, { - "description": "list mapping by Guest OS Type UUID", + "description": "list Guest OS mapping by hypervisor", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "list mapping by Guest OS Type UUID", "length": 255, - "name": "page", + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", @@ -84984,9 +84984,9 @@ "related": "addGuestOsMapping,updateGuestOsMapping", "response": [ { - "description": "the ID of the Guest OS mapping", - "name": "id", - "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", @@ -84994,41 +84994,41 @@ "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "hypervisor specific name for the Guest OS", "name": "osnameforhypervisor", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, - {}, { "description": "the hypervisor", "name": "hypervisor", "type": "string" }, + { + "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": "the ID of the Guest OS mapping", + "name": "id", + "type": "string" } ], "since": "4.4.0" @@ -85039,12 +85039,19 @@ "name": "listTemplates", "params": [ { - "description": "If set to true, list only unique templates across zones", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "showunique", + "name": "account", "required": false, - "since": "4.13.2", - "type": "boolean" + "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 template name", @@ -85054,57 +85061,54 @@ "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "description": "show removed templates as well", "length": 255, - "name": "isvnf", + "name": "showremoved", "required": false, - "since": "4.19.0", "type": "boolean" }, { - "description": "ID of the 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,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "listall", "required": false, - "since": "4.19", - "type": "uuid" + "type": "boolean" }, { - "description": "the IDs of the templates, mutually exclusive with id", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "ids", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.9", - "type": "list" + "type": "uuid" }, { - "description": "show removed templates as well", + "description": "", "length": 255, - "name": "showremoved", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the hypervisor for which to restrict the search", + "description": "list templates by zoneId", "length": 255, - "name": "hypervisor", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the template ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "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" }, @@ -85117,60 +85121,77 @@ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "account", + "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, - "type": "string" + "since": "4.9", + "type": "list" }, { - "description": "List resources by tags (key/value pairs)", + "description": "flag to display the resource image for the templates", "length": 255, - "name": "tags", + "name": "showicon", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "the type of the template", + "length": 255, + "name": "templatetype", + "required": false, + "since": "4.19.0", + "type": "string" }, { "description": "list datadisk templates by parent template id", "length": 255, "name": "parenttemplateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "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", + "description": "ID of the storage pool", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,addImageStore", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "since": "4.19", "type": "uuid" }, { - "description": "the template ID", + "description": "comma separated list of template details requested, value can be a list of [ all, min]", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "details", "required": false, - "type": "uuid" + "since": "4.15", + "type": "list" }, { - "description": "list templates by zoneId", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "isvnf", "required": false, - "type": "uuid" + "since": "4.19.0", + "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": "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).", @@ -85180,19 +85201,11 @@ "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", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "keyword", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -85202,60 +85215,93 @@ "type": "boolean" }, { - "description": "", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "page", + "name": "hypervisor", "required": false, - "type": "integer" + "type": "string" }, { - "description": "flag to display the resource image for the templates", + "description": "ID of the image or image cache store", "length": 255, - "name": "showicon", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, + "since": "4.19", + "type": "uuid" + } + ], + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "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, + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the type of the template", - "length": 255, - "name": "templatetype", - "required": false, - "since": "4.19.0", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" - } - ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "response": [ + }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, + {}, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { @@ -85263,13 +85309,13 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -85278,18 +85324,23 @@ "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": "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", "type": "string" }, { @@ -85308,71 +85359,46 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the URL which the template/iso is registered from", + "name": "url", "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": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the size of the template", - "name": "size", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "description": "the template name", - "name": "name", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { @@ -85381,99 +85407,79 @@ "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, + {}, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the template ID", + "name": "id", "type": "string" }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, { "description": "the ID of the zone for this template", "name": "zoneid", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, - {}, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "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 tag of this template", - "name": "templatetag", + "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", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the project id of the template", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -85482,80 +85488,64 @@ "type": "boolean" }, { - "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", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "CPU Arch of the template", + "name": "arch", "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 date this template was created", - "name": "created", + "description": "the date this template was removed", + "name": "removed", "type": "date" }, { - "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 format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "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": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { "description": "if root disk template, then ids of the datas disk templates this template owns", @@ -85563,13 +85553,23 @@ "type": "set" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" } ] @@ -85598,20 +85598,24 @@ "related": "listTungstenFabricPolicy", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, { "description": "Tungsten-Fabric tag type uuid", "name": "uuid", "type": "string" }, {}, - {}, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -85619,17 +85623,13 @@ "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 provider zone name", "name": "zonename", @@ -85653,9 +85653,9 @@ ], "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", @@ -85663,17 +85663,17 @@ "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.20.0" }, @@ -85682,6 +85682,28 @@ "isasync": true, "name": "createBucket", "params": [ + { + "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": "The Bucket access policy", + "length": 255, + "name": "policy", + "required": false, + "type": "string" + }, { "description": "the project associated with the bucket. Mutually exclusive with account parameter", "length": 255, @@ -85697,13 +85719,6 @@ "required": false, "type": "string" }, - { - "description": "Enable bucket versioning", - "length": 255, - "name": "versioning", - "required": false, - "type": "boolean" - }, { "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, @@ -85720,32 +85735,17 @@ "type": "integer" }, { - "description": "the name of the bucket", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Enable bucket encryption", + "description": "Enable bucket versioning", "length": 255, - "name": "encryption", + "name": "versioning", "required": false, "type": "boolean" }, { - "description": "Id of the Object Storage Pool where bucket is created", + "description": "the name of the bucket", "length": 255, - "name": "objectstorageid", - "related": "addObjectStoragePool", + "name": "name", "required": true, - "type": "uuid" - }, - { - "description": "The Bucket access policy", - "length": 255, - "name": "policy", - "required": false, "type": "string" }, { @@ -85759,47 +85759,47 @@ "related": "listBuckets", "response": [ { - "description": "path of the domain to which the bucket belongs", - "name": "domainpath", + "description": "the domain associated with the bucket", + "name": "domain", "type": "string" }, { - "description": "the project id of the bucket", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" + "description": "name of the Bucket", + "name": "name", + "type": "string" }, { - "description": "ID of the Bucket", - "name": "id", + "description": "Bucket Secret Key", + "name": "usersecretkey", "type": "string" }, { - "description": "Bucket URL", - "name": "url", + "description": "Object storage provider", + "name": "provider", "type": "string" }, { - "description": "the project name of the bucket", - "name": "project", + "description": "State of the Bucket", + "name": "state", "type": "string" }, { - "description": "Bucket Object Locking", - "name": "objectlocking", - "type": "boolean" + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -85807,14 +85807,19 @@ "name": "domainpath", "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", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -85822,24 +85827,19 @@ "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": "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" }, { @@ -85848,43 +85848,27 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "Bucket Versioning", - "name": "versioning", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Bucket Secret Key", - "name": "usersecretkey", - "type": "string" - }, - { - "description": "Bucket Quota in GB", - "name": "quota", - "type": "integer" - }, - { - "description": "Bucket Access Policy", - "name": "policy", + "description": "the account associated with the Bucket", + "name": "account", "type": "string" }, {}, { - "description": "the domain associated with the bucket", - "name": "domain", + "description": "the project name of the bucket", + "name": "project", "type": "string" }, { @@ -85892,25 +85876,26 @@ "name": "accesskey", "type": "string" }, + { + "description": "Bucket Access Policy", + "name": "policy", + "type": "string" + }, { "description": "the date the Bucket was created", "name": "created", "type": "date" }, + {}, { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", - "type": "string" - }, - { - "description": "State of the Bucket", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", - "type": "string" + "description": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" }, { "description": "id of the object storage hosting the Bucket; returned to admin user only", @@ -85918,34 +85903,49 @@ "type": "string" }, { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" + "description": "Bucket URL", + "name": "url", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the Bucket", + "name": "id", + "type": "string" }, { - "description": "the account associated with the Bucket", - "name": "account", + "description": "the project id of the bucket", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Bucket Quota in GB", + "name": "quota", "type": "integer" }, { - "description": "name of the Bucket", - "name": "name", + "description": "the ID of the domain associated with the bucket", + "name": "domainid", "type": "string" }, { - "description": "Object storage provider", - "name": "provider", + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" + }, + { + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", "type": "string" + }, + { + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" + }, + { + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" } ], "since": "4.19.0" @@ -85955,13 +85955,6 @@ "isasync": false, "name": "listPhysicalNetworks", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -85969,13 +85962,6 @@ "required": false, "type": "string" }, - { - "description": "search by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "the Zone ID for the physical network", "length": 255, @@ -85984,6 +85970,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "list physical network by id", "length": 255, @@ -85995,78 +85988,85 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "search by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "updatePhysicalNetwork", "response": [ { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, - {}, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, + {}, { "description": "state of the physical network", "name": "state", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", - "type": "string" - }, - { - "description": "the uuid of the physical network", - "name": "id", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, + {}, { - "description": "comma separated tag", - "name": "tags", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "name of the physical network", + "name": "name", "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": "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": "comma separated tag", + "name": "tags", + "type": "string" + }, + { + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" } ], @@ -86078,33 +86078,35 @@ "name": "listFirewallRules", "params": [ { - "description": "", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "page", + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list firewall rules for certain network", "length": 255, - "name": "isrecursive", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "boolean" + "since": "4.3", + "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 resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Lists rule with the specified ID.", + "description": "", "length": 255, - "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -86114,213 +86116,211 @@ "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "account", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "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": "tags", + "name": "listall", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "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, - "since": "4.4", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list firewall rules for certain network", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.3", "type": "uuid" }, { - "description": "the ID of IP address of the firewall services", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createFirewallRule,updateEgressFirewallRule", "response": [ { - "description": "the ending port of firewall rule's port range", - "name": "endport", + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, - { - "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 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 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 network id of the firewall rule", + "name": "networkid", "type": "string" }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag 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": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" }, { - "description": "the 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": "type of the icmp message being sent", - "name": "icmptype", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", "type": "integer" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, + {}, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the protocol of the firewall rule", + "name": "protocol", "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" }, - {}, { - "description": "the state of the rule", - "name": "state", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "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" } ] }, @@ -86339,6 +86339,16 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -86350,16 +86360,128 @@ "name": "displaytext", "type": "string" }, - {}, + {} + ] + }, + { + "description": "Extracts an ISO", + "isasync": true, + "name": "extractIso", + "params": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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 mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, + "type": "string" }, + { + "description": "the URL to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + } + ], + "related": "extractSnapshot,extractTemplate,downloadImageStoreObject", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the name of the extracted object", + "name": "name", + "type": "string" + }, + { + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" + }, + { + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" + }, + { + "description": "type of the storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "the time and date the object 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 account id to which the extracted object belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + { + "description": "the state of the extracted object", + "name": "state", + "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 status of the extraction", + "name": "status", + "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": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" } ] }, @@ -86369,47 +86491,46 @@ "name": "listRoutingFirewallRules", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "Lists Routing firewall rule with the specified ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list Routing firewall rules by traffic type - ingress or egress", + "description": "list Routing firewall rules by network ID", "length": 255, - "name": "traffictype", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "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 by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list Routing firewall rules by network ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, @@ -86421,47 +86542,48 @@ "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "Lists Routing firewall rule with the specified ID", "length": 255, - "name": "page", + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "List by keyword", + "description": "list Routing firewall rules by traffic type - ingress or egress", "length": 255, - "name": "keyword", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "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": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "fordisplay", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", @@ -86472,49 +86594,8 @@ "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "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": "privateendport", - "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 state of the rule", - "name": "state", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { @@ -86522,86 +86603,101 @@ "name": "tags", "response": [ { - "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "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 project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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" }, { - "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": "id of the resource", + "name": "resourceid", "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" } ], "type": "list" }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, { "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", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "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 id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { @@ -86610,8 +86706,28 @@ "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "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": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "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" }, {}, @@ -86619,263 +86735,168 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + {} ], "since": "4.20.0" }, { - "description": "Extracts an ISO", + "description": "Creates an affinity/anti-affinity group", "isasync": true, - "name": "extractIso", + "name": "createAffinityGroup", "params": [ { - "description": "the ID of the ISO file", + "description": "name of the affinity group", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "Type of the affinity group from the available affinity/anti-affinity group types", "length": 255, - "name": "mode", + "name": "type", "required": true, "type": "string" }, { - "description": "the ID of the zone where the ISO is originally located", + "description": "an account for the affinity group. Must be used with domainId.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the URL to which the ISO would be extracted", - "length": 2048, - "name": "url", + "description": "optional description of the affinity group", + "length": 255, + "name": "description", "required": false, "type": "string" + }, + { + "description": "domainId of the account owning the affinity group", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "create affinity group for project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" } ], - "related": "downloadImageStoreObject,extractSnapshot,extractTemplate", + "related": "", "response": [ { - "description": "type of the storage", - "name": "storagetype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "the type of the affinity group", + "name": "type", + "type": "string" }, - {}, - {}, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, + {}, { - "description": "the id of extracted object", - "name": "id", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the extracted object", - "name": "state", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" - } + }, + {} ] }, { - "description": "Creates an affinity/anti-affinity group", - "isasync": true, - "name": "createAffinityGroup", + "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": "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": "domainId of the account owning the affinity group", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "name of the affinity group", + "description": "Name of the provider", "length": 255, - "name": "name", + "name": "provider", "required": true, "type": "string" }, { - "description": "optional description of the affinity group", + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", "length": 255, - "name": "description", + "name": "secretcode", "required": false, "type": "string" }, { - "description": "create affinity group for project", + "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": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", "name": "domain", + "required": false, "type": "string" }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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 type of the affinity group", - "name": "type", - "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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - {} - ] - }, - { - "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": "Email id with which user tried to login using OAuth provider", "length": 255, @@ -86883,40 +86904,19 @@ "required": true, "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": "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" } ], "related": "", "response": [ { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, { @@ -86925,23 +86925,24 @@ "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" }, { - "description": "first name of the user", - "name": "firstname", + "description": "User ID", + "name": "userid", "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "first name of the user", + "name": "firstname", "type": "string" }, + {}, { - "description": "User ID", - "name": "userid", + "description": "user time zoneoffset", + "name": "timezoneoffset", "type": "string" }, { @@ -86950,34 +86951,34 @@ "type": "string" }, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "Is user registered", + "name": "registered", "type": "string" }, { - "description": "user time zone", - "name": "timezone", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "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", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, { - "description": "Is two factor authentication verified", - "name": "is2faverified", - "type": "string" + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" }, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { @@ -86986,25 +86987,24 @@ "type": "string" }, { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "description": "last name of the user", + "name": "lastname", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" }, - {}, { - "description": "last name of the user", - "name": "lastname", + "description": "Is two factor authentication verified", + "name": "is2faverified", "type": "string" }, { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" + "description": "Two factor authentication provider", + "name": "providerfor2fa", + "type": "string" } ], "since": "4.19.0" @@ -87014,6 +87014,21 @@ "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": "page", + "required": false, + "type": "integer" + }, { "description": "list internal load balancer elements by enabled state", "length": 255, @@ -87028,18 +87043,10 @@ "required": false, "type": "string" }, - { - "description": "list internal load balancer elements by id", - "length": 255, - "name": "id", - "related": "listInternalLoadBalancerElements", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -87050,43 +87057,36 @@ "related": "addNetworkServiceProvider,listTrafficTypes", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "", "response": [ - { - "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" }, - {}, { "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 physical network service provider id of the element", + "name": "nspid", + "type": "string" } ], "since": "4.2.0" @@ -87096,13 +87096,6 @@ "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": "Hypervisor type. One of : VMware, XenServer", "length": 255, @@ -87116,21 +87109,43 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "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" } ], "related": "", "response": [ - {}, { "description": "the guest OS count of the hypervisor", "name": "guestoscount", "type": "integer" }, + {}, + { + "description": "version of the hypervisor for guest os names", + "name": "hypervisorversion", + "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 hypervisor", + "name": "hypervisor", + "type": "string" + }, { "description": "the guest OS list of the hypervisor", "name": "guestoslist", @@ -87148,22 +87163,7 @@ ], "type": "list" }, - { - "description": "the hypervisor", - "name": "hypervisor", - "type": "string" - }, - { - "description": "version of the hypervisor for guest os names", - "name": "hypervisorversion", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.19.0" }, @@ -87173,26 +87173,18 @@ "name": "createTungstenFabricProvider", "params": [ { - "description": "Tungsten-Fabric provider introspect port", - "length": 255, - "name": "tungstenproviderintrospectport", - "required": false, - "type": "string" - }, - { - "description": "Tungsten-Fabric provider vrouter port", + "description": "Tungsten-Fabric provider hostname", "length": 255, - "name": "tungstenprovidervrouterport", - "required": false, + "name": "tungstenproviderhostname", + "required": true, "type": "string" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric provider name", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Tungsten-Fabric provider gateway", @@ -87202,49 +87194,56 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider name", + "description": "Tungsten-Fabric provider port", "length": 255, - "name": "name", - "required": true, + "name": "tungstenproviderport", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric provider hostname", + "description": "Tungsten-Fabric provider vrouter port", "length": 255, - "name": "tungstenproviderhostname", - "required": true, + "name": "tungstenprovidervrouterport", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric provider port", + "description": "Tungsten-Fabric provider introspect port", "length": 255, - "name": "tungstenproviderport", + "name": "tungstenproviderintrospectport", "required": false, "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", - "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": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", "type": "string" }, {}, { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, { @@ -87253,8 +87252,8 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider hostname", - "name": "tungstenproviderhostname", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { @@ -87263,117 +87262,148 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", - "type": "string" + "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 vrouter port", + "name": "tungstenprovidervrouterport", + "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" } ] }, { - "description": "Enables HA cluster-wide", + "description": "Reboots a virtual machine.", "isasync": true, - "name": "enableHAForCluster", + "name": "rebootVirtualMachine", "params": [ { - "description": "ID of the cluster", + "description": "The ID of the virtual machine", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "id", + "related": "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": "Boot into hardware setup menu or not", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" + }, + { + "description": "Force reboot the VM (VM is Stopped and then Started)", + "length": 255, + "name": "forced", + "required": false, + "since": "4.16.0", + "type": "boolean" } ], + "related": "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "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": "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "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 availability zone for the virtual machine", + "name": "zoneid", "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" - } - ], - "since": "4.11" - }, - { - "description": "Reboots a virtual machine.", - "isasync": true, - "name": "rebootVirtualMachine", - "params": [ - { - "description": "Force reboot the VM (VM is Stopped and then Started)", - "length": 255, - "name": "forced", - "required": false, - "since": "4.16.0", - "type": "boolean" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "type": "uuid" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "Boot into hardware setup menu or not", - "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", - "type": "boolean" - } - ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "response": [ + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, { - "description": "the group name of the virtual machine", - "name": "group", + "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 state of the virtual machine", - "name": "state", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { @@ -87382,560 +87412,316 @@ "type": "date" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "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": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, - {}, - {}, { "description": "Vm details in key/value pairs.", "name": "details", "type": "map" }, { - "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "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": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "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 virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project id of the group", - "name": "projectid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "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": "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 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": "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" + "description": "the type of the nic", + "name": "type", + "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": "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 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": "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 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" - } - ], - "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 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" - } - ], - "type": "set" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the netmask of the nic", + "name": "netmask", "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": "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": "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": "tag key name", - "name": "key", - "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": "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" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "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 corresponding network", + "name": "networkid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ + }, { - "description": "tag value", - "name": "value", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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 resource", - "name": "resourceid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" } ], "type": "set" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the account associated with the virtual machine", + "name": "account", + "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the host for the virtual machine", + "name": "hostname", "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 total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { "description": "the name of userdata used for the VM", @@ -87943,22 +87729,107 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "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": "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 disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "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": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "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 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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, { "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", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { @@ -87972,29 +87843,34 @@ "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "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 name of the affinity group", - "name": "name", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "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 account owning the affinity group", + "name": "account", + "type": "string" }, { "description": "the domain ID of the affinity group", @@ -88002,457 +87878,581 @@ "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the pool type of the virtual machine", + "name": "pooltype", "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 when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "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", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project name where tag belongs to", + "name": "project", "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, + } + ], + "type": "set" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "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": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + {}, + {}, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the security group", + "name": "name", "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 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": "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" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "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 account associated with the tag", + "name": "account", + "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 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": "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 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" + } + ], + "type": "set" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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 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": "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" + }, + { + "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": "customer associated with the tag", + "name": "customer", + "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" + }, + { + "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": "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" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the ID of the nic", - "name": "id", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "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 key name", + "name": "key", + "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": "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" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the description of the security group", + "name": "description", "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 project name of the group", + "name": "project", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the security group", + "name": "id", "type": "string" } ], "type": "set" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "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 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 VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "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", - "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 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": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, + {}, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" - }, + } + ] + }, + { + "description": "Enables HA cluster-wide", + "isasync": true, + "name": "enableHAForCluster", + "params": [ { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "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", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "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": "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 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 project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "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 virtual machine", - "name": "hostcontrolstate", - "type": "string" - } - ] + {} + ], + "since": "4.11" }, { "description": "Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", @@ -88463,7 +88463,7 @@ "description": "the IDs of the VMs to add to the cluster", "length": 255, "name": "virtualmachineids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "related": "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" }, @@ -88484,17 +88484,7 @@ } ], "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", @@ -88505,6 +88495,16 @@ "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" @@ -88515,11 +88515,11 @@ "name": "listTungstenFabricLogicalRouter", "params": [ { - "description": "the uuid of Tungsten-Fabric network", + "description": "", "length": 255, - "name": "networkuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "the uuid of Tungsten-Fabric logical router", @@ -88529,69 +88529,69 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "keyword", + "name": "networkuuid", "required": false, "type": "string" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "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": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, { "description": "Tungsten-Fabric logical router name", "name": "name", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -88605,12 +88605,11 @@ "name": "addGuestOsMapping", "params": [ { - "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", + "description": "OS name specific to the hypervisor", "length": 255, - "name": "forced", - "required": false, - "since": "4.19.0", - "type": "boolean" + "name": "osnameforhypervisor", + "required": true, + "type": "string" }, { "description": "Hypervisor type. One of : XenServer, KVM, VMWare", @@ -88620,33 +88619,27 @@ "type": "string" }, { - "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", + "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "osdisplayname", "required": false, - "type": "uuid" - }, - { - "description": "OS name specific to the hypervisor", - "length": 255, - "name": "osnameforhypervisor", - "required": true, "type": "string" }, { - "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", + "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", "length": 255, - "name": "hypervisorversion", - "required": true, - "type": "string" + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" }, { - "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", + "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", "length": 255, - "name": "osdisplayname", + "name": "forced", "required": false, - "type": "string" + "since": "4.19.0", + "type": "boolean" }, { "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.)", @@ -88655,55 +88648,62 @@ "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" } ], "related": "updateGuestOsMapping", "response": [ { - "description": "the ID of the Guest OS mapping", - "name": "id", - "type": "string" - }, - { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" }, + {}, { "description": "version of the hypervisor for mapping", "name": "hypervisorversion", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "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 hypervisor", + "name": "hypervisor", + "type": "string" }, - {}, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" } ], @@ -88715,50 +88715,44 @@ "name": "listVnfTemplates", "params": [ { - "description": "If set to true, list only unique templates across zones", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "showunique", + "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.13.2", - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "", + "description": "the template ID", "length": 255, - "name": "page", + "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": "integer" + "type": "uuid" }, { - "description": "show removed templates as well", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "length": 255, - "name": "showremoved", + "name": "isvnf", "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "list datadisk templates by parent template id", - "length": 255, - "name": "parenttemplateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": false, - "since": "4.4", - "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", - "required": false, - "type": "boolean" + "name": "templatefilter", + "required": true, + "type": "string" }, { - "description": "list templates by zoneId", + "description": "comma separated list of template details requested, value can be a list of [ all, min]", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "details", "required": false, - "type": "uuid" + "since": "4.15", + "type": "list" }, { "description": "the template name", @@ -88768,66 +88762,65 @@ "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).", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "templatefilter", - "required": true, - "type": "string" + "name": "showunique", + "required": false, + "since": "4.13.2", + "type": "boolean" }, { - "description": "flag to display the resource image for the templates", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "showicon", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "list datadisk templates by parent template id", "length": 255, - "name": "keyword", + "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, - "type": "string" + "since": "4.4", + "type": "uuid" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "description": "the type of the template", "length": 255, - "name": "isvnf", + "name": "templatetype", "required": false, "since": "4.19.0", - "type": "boolean" + "type": "string" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "list templates by zoneId", "length": 255, - "name": "arch", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.20", - "type": "string" + "type": "uuid" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "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, - "since": "4.15", - "type": "list" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the IDs of the templates, mutually exclusive with id", + "description": "show removed templates as well", "length": 255, - "name": "ids", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "showremoved", "required": false, - "since": "4.9", - "type": "list" + "type": "boolean" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -88838,32 +88831,40 @@ "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the type of the template", + "description": "List by keyword", "length": 255, - "name": "templatetype", + "name": "keyword", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { @@ -88874,67 +88875,51 @@ "type": "map" }, { - "description": "the template ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the hypervisor for which to restrict the search", + "description": "flag to display the resource image for the templates", "length": 255, - "name": "hypervisor", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,updateIso,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": "the date this template was removed", - "name": "removed", - "type": "date" + "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": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "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": "the format of the template.", + "name": "format", + "type": "imageformat" }, { "description": "the ID of the secondary storage host for the template", @@ -88942,19 +88927,14 @@ "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "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": "if Datadisk template, then id of the root disk template this template belongs to", @@ -88962,91 +88942,34 @@ "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": "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": "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": "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 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 physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the template 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 tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { "description": "the hypervisor on which the template runs", @@ -89054,23 +88977,28 @@ "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { @@ -89079,130 +89007,186 @@ "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "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": "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "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": "true if this template is a public template, false otherwise", - "name": "ispublic", - "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "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": "the project name of the template", - "name": "project", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", + "description": "the date this template was removed", + "name": "removed", "type": "date" }, { - "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 processor bit size", - "name": "bits", - "type": "int" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the template ID", - "name": "id", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "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 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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", @@ -89210,26 +89194,42 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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 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 processor bit size", + "name": "bits", + "type": "int" + }, + {}, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + {}, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, { "description": "true if the template is managed across all Zones, false otherwise", "name": "crossZones", "type": "boolean" - }, - {} + } ], "since": "4.19.0" }, @@ -89239,28 +89239,27 @@ "name": "deployVnfAppliance", "params": [ { - "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": "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": "rootdisksize", + "name": "hypervisor", "required": false, - "since": "4.4", - "type": "long" + "type": "string" }, { - "description": "availability zone for the virtual machine", + "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": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "boottype", + "required": false, + "since": "4.14.0.0", + "type": "string" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "description": "Enable packed virtqueues or not.", + "length": 255, + "name": "nicpackedvirtqueuesenabled", "required": false, - "since": "4.12", - "type": "string" + "since": "4.18", + "type": "boolean" }, { "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", @@ -89271,11 +89270,12 @@ "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. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", + "description": "The number of queues for multiqueue NICs.", + "length": 255, + "name": "nicmultiqueuenumber", "required": false, - "type": "string" + "since": "4.18", + "type": "integer" }, { "description": "the ip address for default vm's network", @@ -89285,186 +89285,185 @@ "type": "string" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "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": "password", + "name": "keyboard", "required": false, - "since": "4.19.0.0", "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "account", + "name": "copyimagetags", "required": false, - "type": "string" + "since": "4.13", + "type": "boolean" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "size", + "name": "dynamicscalingenabled", "required": false, - "type": "long" + "since": "4.16", + "type": "boolean" }, { - "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": "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": "hypervisor", + "name": "securitygroupids", + "related": "updateSecurityGroup", "required": false, - "type": "string" + "type": "list" }, { - "description": "an optional group for the virtual machine", + "description": "the mac address for default vm's network", "length": 255, - "name": "group", + "name": "macaddress", "required": false, "type": "string" }, { - "description": "host name for the virtual machine", + "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": "name", + "name": "bootmode", "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "Deploy vm for the project", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "size", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "customid", + "name": "displayname", "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": "Controls specific policies on IO", + "description": "host name for the virtual machine", "length": 255, - "name": "iodriverpolicy", + "name": "name", "required": false, "type": "string" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "nicmultiqueuenumber", + "name": "password", "required": false, - "since": "4.18", - "type": "integer" + "since": "4.19.0.0", + "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": "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": "diskofferingid", - "related": "", + "name": "iptonetworklist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the ipv6 address for default vm's network", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "ip6address", + "name": "keypairs", "required": false, - "type": "string" + "since": "4.17", + "type": "list" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", - "length": 255, - "name": "deploymentplanner", + "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.4", + "since": "4.12", "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.", + "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": "bootmode", + "name": "affinitygroupids", + "related": "", "required": false, - "since": "4.14.0.0", - "type": "string" + "type": "list" }, { - "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": "used to specify the vApp properties.", "length": 255, - "name": "datadiskofferinglist", + "name": "properties", "required": false, - "since": "4.11", + "since": "4.15", "type": "map" }, { - "description": "the ID of the template for the virtual machine", + "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": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" + "name": "rootdisksize", + "required": false, + "since": "4.4", + "type": "long" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "details", + "name": "account", "required": false, - "since": "4.3", - "type": "map" + "type": "string" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "bootintosetup", + "name": "displayvm", "required": false, - "since": "4.15.0.0", + "since": "4.2", "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": "Deploy vm for the project", "length": 255, - "name": "iptonetworklist", + "name": "projectid", + "related": "createProject", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "used to specify the vApp properties.", + "description": "an optional group for the virtual machine", "length": 255, - "name": "properties", + "name": "group", "required": false, - "since": "4.15", - "type": "map" + "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "dynamicscalingenabled", + "name": "startvm", "required": false, - "since": "4.16", "type": "boolean" }, { - "description": "an optional user generated name for the virtual machine", + "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": "displayname", + "name": "vnfcidrlist", + "required": false, + "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. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", "required": false, "type": "string" }, { - "description": "the ID of the service offering for the virtual machine", + "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": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "securitygroupnames", + "related": "updateSecurityGroup", + "required": false, + "type": "list" }, { "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.", @@ -89474,36 +89473,43 @@ "type": "boolean" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "description": "Controls specific policies on IO", "length": 255, - "name": "copyimagetags", + "name": "iodriverpolicy", "required": false, - "since": "4.13", - "type": "boolean" + "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "displayvm", + "name": "details", "required": false, - "since": "4.2", - "type": "boolean" + "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.", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "boottype", - "required": false, - "since": "4.14.0.0", - "type": "string" + "name": "templateid", + "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": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "affinitygroupids", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "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": "list" + "type": "uuid" }, { "description": "destination Host ID to deploy the VM to - parameter available for root admin only", @@ -89514,20 +89520,19 @@ "type": "uuid" }, { - "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": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "vnfcidrlist", + "name": "customid", "required": false, - "type": "list" + "type": "string" }, { - "description": "the ID of the Userdata", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "userdataid", - "related": "", + "name": "userdatadetails", "required": false, "since": "4.18", - "type": "uuid" + "type": "map" }, { "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", @@ -89537,269 +89542,350 @@ "type": "map" }, { - "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": "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": "securitygroupids", - "related": "updateSecurityGroup", + "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": "used to specify the parameters values for the variables in userdata.", + "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": "userdatadetails", + "name": "overridediskofferingid", + "related": "", "required": false, - "since": "4.18", - "type": "map" + "since": "4.17", + "type": "uuid" }, { - "description": "the mac address for default vm's network", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "macaddress", + "name": "keypair", "required": false, "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": "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": "keyboard", + "name": "nicnetworklist", "required": false, - "type": "string" + "since": "4.15", + "type": "map" }, { - "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": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "securitygroupnames", - "related": "updateSecurityGroup", + "name": "bootintosetup", "required": false, - "type": "list" + "since": "4.15.0.0", + "type": "boolean" }, { - "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": "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": "iothreadsenabled", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "boolean" + "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": "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": "affinitygroupnames", - "related": "", + "name": "datadiskofferinglist", "required": false, - "type": "list" + "since": "4.11", + "type": "map" }, { - "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": "the ID of the Userdata", "length": 255, - "name": "nicnetworklist", + "name": "userdataid", + "related": "", "required": false, - "since": "4.15", - "type": "map" + "since": "4.18", + "type": "uuid" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "startvm", + "name": "ip6address", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Enable packed virtqueues or not.", + "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": "nicpackedvirtqueuesenabled", + "name": "iothreadsenabled", "required": false, - "since": "4.18", "type": "boolean" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "availability zone for the virtual machine", "length": 255, - "name": "keypairs", - "required": false, - "since": "4.17", - "type": "list" + "name": "zoneid", + "related": "listZones", + "required": true, + "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": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "overridediskofferingid", - "related": "", + "name": "deploymentplanner", "required": false, - "since": "4.17", - "type": "uuid" + "since": "4.4", + "type": "string" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "related": "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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "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 virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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 list of resource tags associated", - "name": "tags", + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "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 name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "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 VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "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 userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "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", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "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": "Base64 string representation of the resource icon", @@ -89807,48 +89893,139 @@ "type": "resourceiconresponse" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, { "description": "Name of AutoScale VM group", "name": "autoscalevmgroupname", "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": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "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 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", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "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 name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -89857,18 +90034,38 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { @@ -89876,81 +90073,111 @@ "name": "securitygroup", "response": [ { - "description": "the domain ID of the security group", - "name": "domainid", - "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 project id of the group", - "name": "projectid", + "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 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": "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": "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", + "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": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -89960,67 +90187,37 @@ } ], "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 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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" } ], "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -90029,8 +90226,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -90039,13 +90236,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -90054,8 +90246,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -90064,85 +90256,40 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "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 name of the security group", - "name": "name", - "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 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 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": "account owning the security group rule", - "name": "account", - "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", + "description": "the protocol of the security group rule", + "name": "protocol", "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" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -90150,100 +90297,148 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "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 account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" + }, + { + "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 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": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the name of the security group", + "name": "name", + "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": "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" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "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 ID of the virtual machine", - "name": "id", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, - {}, - {}, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { "description": "the memory allocated for the virtual machine", @@ -90251,117 +90446,129 @@ "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "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", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "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": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "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 ID of the nic", - "name": "id", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the account associated with the tag", + "name": "account", "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" - }, + } + ], + "type": "set" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ID of the corresponding network", + "name": "networkid", "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": "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 Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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 netmask of the nic", - "name": "netmask", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -90370,18 +90577,18 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of the nic", + "name": "gateway", "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 ip address of the nic", - "name": "ipaddress", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -90390,289 +90597,96 @@ "type": "list" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - } - ], - "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 name of the domain in which the virtual machine exists", - "name": "domain", - "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "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 virtual machine", - "name": "name", - "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", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "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": "publicip", - "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 id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "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", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "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 ID of the affinity group", - "name": "id", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" } ], "type": "set" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { @@ -90681,53 +90695,39 @@ "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the project id of the vm", + "name": "projectid", "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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, + {}, { - "description": "User VM type", - "name": "vmtype", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" } ], @@ -90739,9 +90739,9 @@ "name": "updateNetworkOffering", "params": [ { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "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": "domainid", + "name": "availability", "required": false, "type": "string" }, @@ -90752,6 +90752,14 @@ "required": false, "type": "integer" }, + { + "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 display text of the network offering", "length": 255, @@ -90767,33 +90775,19 @@ "type": "string" }, { - "description": "the id of the network offering", - "length": 255, - "name": "id", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", - "required": false, - "type": "uuid" - }, - { - "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 name of the network offering", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", "length": 255, - "name": "name", + "name": "domainid", "required": false, "type": "string" }, { - "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 id of the network offering", "length": 255, - "name": "availability", + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "string" + "type": "uuid" }, { "description": "update state for the network offering", @@ -90803,11 +90797,10 @@ "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 4096, - "name": "zoneid", + "description": "the name of the network offering", + "length": 255, + "name": "name", "required": false, - "since": "4.13", "type": "string" }, { @@ -90816,70 +90809,56 @@ "name": "sortkey", "required": false, "type": "integer" + }, + { + "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" } ], "related": "createNetworkOffering,listNetworkOfferings", "response": [ - { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" - }, - { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", - "type": "string" - }, - {}, - { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, { "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "zoneid", "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the name of the network offering", + "name": "name", "type": "string" }, - { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" - }, { "description": "the date this network offering was created", "name": "created", "type": "date" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "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 guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", "type": "boolean" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" }, { - "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": "maximum number of concurrents connections to be handled by lb", @@ -90887,23 +90866,48 @@ "type": "integer" }, { - "description": "availability of the network offering", - "name": "availability", + "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", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" + }, + { + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, + { + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the id of the network offering", + "name": "id", "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" + }, + { + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { @@ -90925,8 +90929,8 @@ "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -90935,23 +90939,23 @@ "type": "list" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "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": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" } ], @@ -90983,101 +90987,97 @@ "type": "list" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "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": "availability of the network offering", + "name": "availability", + "type": "string" }, { "description": "true if network offering supports public access for guest networks", "name": "supportspublicaccess", "type": "boolean" }, + {}, { "description": "the routing mode for the network offering, supported types are Static or Dynamic.", "name": "routingmode", "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": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the network offering", - "name": "name", - "type": "string" + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" - }, - { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", + "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": "supportsinternallb", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "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": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", "type": "boolean" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", "type": "boolean" }, { - "description": "the id of the network offering", - "name": "id", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "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" + "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 can be used by NSX networks only", "name": "fornsx", "type": "boolean" - }, - {} + } ] }, { @@ -91104,26 +91104,11 @@ "related": "enableOutOfBandManagementForHost", "response": [ { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, - { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, {}, - { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" - }, { "description": "the operation result description", "name": "description", @@ -91135,8 +91120,8 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { @@ -91146,28 +91131,43 @@ }, {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "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 operation result", + "name": "status", + "type": "boolean" + }, { "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", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" + }, + { + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" } ], @@ -91179,41 +91179,11 @@ "name": "listResourceDetails", "params": [ { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,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. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list by resource id", - "length": 255, - "name": "resourceid", - "required": false, - "type": "string" - }, - { - "description": "list by key, value. Needs to be passed only along with key", + "description": "", "length": 255, - "name": "value", + "name": "page", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" }, { "description": "", @@ -91222,14 +91192,6 @@ "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": "list by key", "length": 255, @@ -91238,25 +91200,18 @@ "type": "string" }, { - "description": "list by resource type", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "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": "if set to true, only details marked with display=true, are returned. False by default", @@ -91267,135 +91222,73 @@ "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - } - ], - "related": "", - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, - {}, { - "description": "the account associated with the tag", - "name": "account", - "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 project id the tag belongs to", - "name": "projectid", + "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": "id of the resource", + "description": "list by resource id", + "length": 255, "name": "resourceid", + "required": false, "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", + "description": "list by resource type", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "resourcetype", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the name of the account which needs dedication. 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": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" } ], - "related": "listDedicatedClusters", + "related": "", "response": [ { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -91404,22 +91297,54 @@ "type": "string" }, { - "description": "the name of the cluster", - "name": "clustername", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, {}, { - "description": "the Account ID of the cluster", - "name": "accountid", + "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 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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.2" }, { "description": "Creates a network offering.", @@ -91427,78 +91352,80 @@ "name": "createNetworkOffering", "params": [ { - "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": "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": "keepaliveenabled", + "name": "details", "required": false, - "type": "boolean" + "since": "4.2.0", + "type": "map" }, { - "description": "services supported by the network offering", + "description": "true if network offering for NSX network offering supports Internal Load balancer service.", "length": 255, - "name": "supportedservices", + "name": "nsxsupportsinternallb", "required": false, - "type": "list" + "since": "4.20.0", + "type": "boolean" }, { - "description": "true if the network offering is IP conserve mode enabled", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "conservemode", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "since": "4.13", + "type": "list" }, { - "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", + "description": "desired service capabilities as part of network offering", "length": 255, - "name": "specifyipranges", + "name": "servicecapabilitylist", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "maximum number of concurrent connections supported by the network offering", + "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": "maxconnections", + "name": "serviceproviderlist", "required": false, - "type": "integer" + "type": "map" }, { - "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", "length": 255, - "name": "routingmode", + "name": "egressdefaultpolicy", "required": false, - "since": "4.20.0", - "type": "string" + "type": "boolean" }, { - "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", + "description": "the traffic type for the network offering. Supported type in current release is GUEST only", "length": 255, - "name": "internetprotocol", - "required": false, - "since": "4.17.0", + "name": "traffictype", + "required": true, "type": "string" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "true if the network offering is IP conserve mode enabled", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "conservemode", "required": false, - "since": "4.13", - "type": "list" + "type": "boolean" }, { - "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", + "description": "the service offering ID used by virtual router provider", "length": 255, - "name": "fortungsten", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "ispersistent", + "name": "routingmode", "required": false, - "type": "boolean" + "since": "4.20.0", + "type": "string" }, { "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", @@ -91509,93 +91436,100 @@ "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "description": "true if network offering supports persistent networks; defaulted to false if not specified", "length": 255, - "name": "egressdefaultpolicy", + "name": "ispersistent", "required": false, "type": "boolean" }, { - "description": "desired service capabilities as part of network offering", - "length": 255, - "name": "servicecapabilitylist", + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, - "type": "map" + "type": "string" }, { - "description": "true if network offering is meant to be used for VPC, false otherwise.", + "description": "set to true if the offering is to be enabled during creation. Default is false", "length": 255, - "name": "forvpc", + "name": "enable", "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", + "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", "length": 255, - "name": "enable", + "name": "fortungsten", "required": false, - "since": "4.16", "type": "boolean" }, { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", + "description": "true if network offering is meant to be used for NSX, false otherwise.", + "length": 255, + "name": "fornsx", "required": false, - "type": "string" + "since": "4.20.0", + "type": "boolean" }, { - "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 ", + "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": "availability", + "name": "internetprotocol", "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "guest type of the network offering: Shared or Isolated", + "description": "true if network offering for NSX network offering supports Load balancer service.", "length": 255, - "name": "guestiptype", - "required": true, - "type": "string" + "name": "nsxsupportlb", + "required": false, + "since": "4.20.0", + "type": "boolean" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "true if network offering supports vlans", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "specifyvlan", "required": false, - "type": "list" + "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", + "description": "maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "details", + "name": "maxconnections", "required": false, - "since": "4.2.0", - "type": "map" + "type": "integer" }, { - "description": "true if network offering for NSX network offering supports Internal Load balancer service.", + "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": "nsxsupportsinternallb", + "name": "keepaliveenabled", "required": false, - "since": "4.20.0", "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "networkrate", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "integer" + "type": "list" }, { - "description": "true if network offering for NSX network offering supports Load balancer service.", + "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": "nsxsupportlb", + "name": "availability", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "string" + }, + { + "description": "data transfer rate in megabits per second allowed", + "length": 255, + "name": "networkrate", + "required": false, + "type": "integer" }, { "description": "the display text of the network offering, defaults to the value of 'name'.", @@ -91613,25 +91547,30 @@ "type": "boolean" }, { - "description": "the service offering ID used by virtual router provider", + "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "specifyipranges", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if network offering is meant to be used for NSX, false otherwise.", + "description": "services supported by the network offering", "length": 255, - "name": "fornsx", + "name": "supportedservices", + "required": false, + "type": "list" + }, + { + "description": "true if network offering is meant to be used for VPC, false otherwise.", + "length": 255, + "name": "forvpc", "required": false, - "since": "4.20.0", "type": "boolean" }, { - "description": "the traffic type for the network offering. Supported type in current release is GUEST only", + "description": "guest type of the network offering: Shared or Isolated", "length": 255, - "name": "traffictype", + "name": "guestiptype", "required": true, "type": "string" }, @@ -91641,98 +91580,170 @@ "name": "name", "required": true, "type": "string" - }, - { - "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", - "length": 255, - "name": "serviceproviderlist", - "required": false, - "type": "map" - }, - { - "description": "true if network offering supports vlans", - "length": 255, - "name": "specifyvlan", - "required": false, - "type": "boolean" } ], "related": "listNetworkOfferings", "response": [ { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", - "type": "string" + "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": "conservemode", + "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": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "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 offering", + "name": "id", + "type": "string" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" + "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 value", + "name": "value", + "type": "string" + }, + { + "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" + } + ], + "type": "list" + }, + { + "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 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": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", "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 internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" + }, { "description": "the tags for the network offering", "name": "tags", "type": "string" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { - "description": "true if network offering can be used by NSX networks only", - "name": "fornsx", + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", "type": "boolean" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportsinternallb", + "description": "true if network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "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 is default, false otherwise", - "name": "isdefault", + "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 guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "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.", @@ -91745,86 +91756,131 @@ "type": "integer" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" - }, - { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "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", + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the name of the network offering", - "name": "name", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, { - "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": "supportsinternallb", + "type": "boolean" }, { "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "zoneid", "type": "string" }, - {}, - {}, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "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 supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" }, + {}, { - "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": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" + }, + { + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", - "type": "string" + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" + } + ], + "since": "3.0.0" + }, + { + "description": "Dedicate an existing cluster", + "isasync": true, + "name": "dedicateCluster", + "params": [ + { + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the Cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "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 ID of the cluster", + "name": "clusterid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -91832,93 +91888,37 @@ "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the domain ID of the cluster", + "name": "domainid", "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "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" - } - ], - "type": "list" - }, - { - "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": "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" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "the Account ID of the cluster", + "name": "accountid", + "type": "string" }, { - "description": "the id of the network offering", + "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 name of the cluster", + "name": "clustername", + "type": "string" + }, + { + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", + "type": "string" } - ], - "since": "3.0.0" + ] }, { "description": "Creates an IP forwarding rule", @@ -91926,18 +91926,19 @@ "name": "createIpForwardingRule", "params": [ { - "description": "the end port for the rule", + "description": "the public IP address ID of the forwarding rule, already associated via associateIp", "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { - "description": "the start port for the rule", + "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": "startport", - "required": true, - "type": "integer" + "name": "cidrlist", + "required": false, + "type": "list" }, { "description": "the protocol for the rule. Valid values are TCP or UDP.", @@ -91954,94 +91955,36 @@ "type": "boolean" }, { - "description": "the public IP address ID of the forwarding rule, already associated via associateIp", + "description": "the start port for the rule", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "startport", "required": true, - "type": "uuid" + "type": "integer" }, { - "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.", + "description": "the end port for the rule", "length": 255, - "name": "cidrlist", + "name": "endport", "required": false, - "type": "list" + "type": "integer" } ], "related": "createPortForwardingRule,updatePortForwardingRule", "response": [ { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "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": "the state of the rule", + "name": "state", + "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": "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": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "list" + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { "description": "the public ip address id for the port forwarding rule", @@ -92049,18 +91992,18 @@ "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "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 ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { @@ -92069,8 +92012,8 @@ "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { @@ -92083,11 +92026,6 @@ "name": "networkid", "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", @@ -92095,31 +92033,93 @@ "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "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": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "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": [ + { + "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": "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": "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": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -92143,18 +92143,23 @@ "related": "listElastistorVolume", "response": [ { - "description": "the id of the volume", - "name": "id", + "description": "synchronization", + "name": "sync", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "compression", "name": "compression", "type": "string" }, { - "description": "synchronization", - "name": "sync", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -92162,28 +92167,23 @@ "name": "deduplication", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, + {}, + {}, { - "description": "graceallowed", - "name": "graceallowed", + "description": "the id of the volume", + "name": "id", "type": "string" }, { "description": "the name of the volume", "name": "name", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ] }, { @@ -92192,19 +92192,12 @@ "name": "quotaStatement", "params": [ { - "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": true, - "type": "uuid" - }, - { - "description": "List quota usage records for the specified usage type", + "description": "List usage records for the specified account", "length": 255, - "name": "type", + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "Optional, Account Id for which statement needs to be generated", @@ -92214,18 +92207,11 @@ "type": "string" }, { - "description": "Start of the period of the Quota statement. 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.", + "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", "length": 255, - "name": "startdate", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": true, - "type": "date" - }, - { - "description": "List usage records for the specified account", - "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", - "required": false, "type": "uuid" }, { @@ -92234,34 +92220,47 @@ "name": "enddate", "required": true, "type": "date" + }, + { + "description": "Start of the period of the Quota statement. 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": "date" + }, + { + "description": "List quota usage records for the specified usage type", + "length": 255, + "name": "type", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "account id", - "name": "accountid", - "type": "long" + "description": "account name", + "name": "account", + "type": "string" }, { - "description": "quota consumed", - "name": "quota", - "type": "bigdecimal" + "description": "usage type", + "name": "type", + "type": "int" }, { "description": "domain id", "name": "domain", "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "usage type name", + "name": "name", + "type": "string" }, { - "description": "account name", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -92269,21 +92268,22 @@ "name": "unit", "type": "string" }, - {}, { - "description": "usage type name", - "name": "name", - "type": "string" + "description": "account id", + "name": "accountid", + "type": "long" }, { - "description": "usage type", - "name": "type", - "type": "int" + "description": "quota consumed", + "name": "quota", + "type": "bigdecimal" }, + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.7.0" @@ -92293,14 +92293,6 @@ "isasync": true, "name": "updateLBStickinessPolicy", "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": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -92316,49 +92308,36 @@ "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 account of the Stickiness policy", - "name": "account", - "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 state of the policy", - "name": "state", - "type": "string" - }, { "description": "the LB rule ID", "name": "lbruleid", "type": "string" }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the domain of the Stickiness policy", - "name": "domain", + { + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { @@ -92367,17 +92346,17 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the policy", + "name": "state", + "type": "string" }, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the state of the policy", + "name": "state", "type": "string" }, { @@ -92386,9 +92365,14 @@ "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", - "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" }, { "description": "the LB Stickiness policy ID", @@ -92396,24 +92380,40 @@ "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the state of the policy", - "name": "state", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" } ], "type": "list" }, - {} + { + "description": "the name of the Stickiness policy", + "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 domain of the Stickiness policy", + "name": "domain", + "type": "string" + } ], "since": "4.4" }, @@ -92423,39 +92423,32 @@ "name": "listPods", "params": [ { - "description": "list Pods by name", + "description": "list pods by allocation state", "length": 255, - "name": "name", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "flag to display the capacity of the pods", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - }, - { - "description": "list pods by allocation state", + "description": "", "length": 255, - "name": "allocationstate", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "list Pods by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "flag to display the capacity of the pods", "length": 255, - "name": "page", + "name": "showcapacities", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "list Pods by ID", @@ -92465,6 +92458,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "list Pods by Zone ID", "length": 255, @@ -92474,11 +92474,11 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "createManagementNetworkIpRange", @@ -92488,24 +92488,24 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the netmask of the Pod", "name": "netmask", "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 capacity of the Pod", "name": "capacity", "response": [ { - "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", @@ -92528,13 +92528,13 @@ "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -92543,8 +92543,13 @@ "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -92553,116 +92558,111 @@ "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "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": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", "type": "string" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 name of the Pod", "name": "name", "type": "string" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "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", + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", "type": "list" }, + {}, { "description": "the allocation state of the Pod", "name": "allocationstate", "type": "string" }, - {}, - {}, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "the ID of the Pod", + "name": "id", "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 ID of the Pod", - "name": "id", + "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", + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", "type": "list" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "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": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "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 gateway of the Pod", - "name": "gateway", + "description": "the Zone ID of the Pod", + "name": "zoneid", "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 gateway of the Pod", + "name": "gateway", + "type": "string" } ] }, @@ -92689,27 +92689,27 @@ ], "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": "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" - } + }, + {} ] }, { @@ -92717,13 +92717,6 @@ "isasync": false, "name": "quotaTariffList", "params": [ - { - "description": "If set to true, we will list only the removed tariffs. The default is false.", - "length": 255, - "name": "listonlyremoved", - "required": false, - "type": "boolean" - }, { "description": "The quota tariff's id.", "length": 255, @@ -92739,25 +92732,18 @@ "type": "integer" }, { - "description": "The start date of the quota tariff. 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.", + "description": "The end date of the quota tariff. 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": "startdate", + "name": "enddate", "required": false, + "since": "4.18.0.0", "type": "date" }, { - "description": "Usage type of the resource", - "length": 255, - "name": "usagetype", - "required": false, - "type": "integer" - }, - { - "description": "False will list only not removed quota tariffs. If set to true, we will list all, including the removed ones. The default is false.", + "description": "If set to true, we will list only the removed tariffs. The default is false.", "length": 255, - "name": "listall", + "name": "listonlyremoved", "required": false, - "since": "4.18.0.0", "type": "boolean" }, { @@ -92767,6 +92753,14 @@ "required": false, "type": "string" }, + { + "description": "False will list only not removed quota tariffs. If set to true, we will list all, including the removed ones. The default is false.", + "length": 255, + "name": "listall", + "required": false, + "since": "4.18.0.0", + "type": "boolean" + }, { "description": "", "length": 255, @@ -92783,49 +92777,41 @@ "type": "string" }, { - "description": "The end date of the quota tariff. 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.", + "description": "Usage type of the resource", "length": 255, - "name": "enddate", + "name": "usagetype", + "required": false, + "type": "integer" + }, + { + "description": "The start date of the quota tariff. 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, - "since": "4.18.0.0", "type": "date" } ], "related": "", "response": [ - { - "description": "usageType", - "name": "usageType", - "type": "int" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "position in the execution sequence for tariffs of the same type", "name": "position", "type": "integer" }, - { - "description": "the start date of the quota tariff", - "name": "effectiveDate", - "type": "date" - }, + {}, { "description": "usage type description", "name": "usageTypeDescription", "type": "string" }, { - "description": "tariffValue", - "name": "tariffValue", - "type": "bigdecimal" + "description": "usageDiscriminator", + "name": "usageDiscriminator", + "type": "string" }, { - "description": "activation rule of the quota tariff", - "name": "activationRule", + "description": "currency", + "name": "currency", "type": "string" }, { @@ -92833,52 +92819,66 @@ "name": "description", "type": "string" }, + { + "description": "activation rule of the quota tariff", + "name": "activationRule", + "type": "string" + }, { "description": "when the quota tariff was removed", "name": "removed", "type": "date" }, { - "description": "the end date of the quota tariff", - "name": "endDate", + "description": "the start date of the quota tariff", + "name": "effectiveDate", "type": "date" }, - {}, + { + "description": "usageUnit", + "name": "usageUnit", + "type": "string" + }, { "description": "the ID of the tariff", "name": "id", "type": "string" }, { - "description": "name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "usageDiscriminator", - "name": "usageDiscriminator", - "type": "string" + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" }, { - "description": "usageUnit", - "name": "usageUnit", + "description": "name", + "name": "name", "type": "string" }, - {}, { - "description": "usageName", - "name": "usageName", - "type": "string" + "description": "usageType", + "name": "usageType", + "type": "int" }, { - "description": "currency", - "name": "currency", + "description": "usageName", + "name": "usageName", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" } ], "since": "4.7.0" @@ -92903,170 +92903,38 @@ "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": "Lists IPv4 subnets for zone.", - "isasync": false, - "name": "listIpv4SubnetsForZone", - "params": [ - { - "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" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "project who which the IPv4 subnet is dedicated to", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "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": "UUID of the IPv4 subnet.", - "length": 255, - "name": "id", - "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "required": false, - "type": "uuid" - }, - { - "description": "CIDR of the IPv4 subnet.", - "length": 255, - "name": "subnet", - "required": false, - "type": "string" - } - ], - "related": "dedicateIpv4SubnetForZone", - "response": [ - {}, - { - "description": "the project id of the IPv4 subnet", - "name": "projectid", - "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" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "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 project name of the IPv4 subnet", - "name": "project", - "type": "string" - }, - { - "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": "the account of the IPv4 subnet", - "name": "account", - "type": "string" - }, - { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" - }, - { - "description": "guest IPv4 subnet", - "name": "subnet", - "type": "string" } - ], - "since": "4.20.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, @@ -93075,11 +92943,11 @@ "type": "string" }, { - "description": "ID of the project to add the account to", + "description": "ID of the project role", "length": 255, - "name": "projectid", - "related": "createProject", - "required": true, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, "type": "uuid" }, { @@ -93095,22 +92963,14 @@ "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": "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", @@ -93124,9 +92984,9 @@ }, {}, { - "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" @@ -93136,6 +92996,20 @@ "isasync": false, "name": "listSnapshots", "params": [ + { + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "length": 255, + "name": "intervaltype", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "List resources by tags (key/value pairs)", "length": 255, @@ -93144,28 +93018,27 @@ "type": "map" }, { - "description": "ID of the image or image cache store", + "description": "the IDs of the snapshots, mutually exclusive with id", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,addImageStore", + "name": "ids", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "required": false, - "since": "4.19", - "type": "uuid" + "since": "4.9", + "type": "list" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list snapshots by zone id", + "description": "lists snapshot by snapshot name", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "lists snapshot by snapshot ID", @@ -93176,20 +93049,11 @@ "type": "uuid" }, { - "description": "valid values are MANUAL or RECURRING.", - "length": 255, - "name": "snapshottype", - "required": false, - "type": "string" - }, - { - "description": "the IDs of the snapshots, mutually exclusive with id", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "ids", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "name": "isrecursive", "required": false, - "since": "4.9", - "type": "list" + "type": "boolean" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -93200,11 +93064,13 @@ "type": "uuid" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "description": "ID of the image or image cache store", "length": 255, - "name": "intervaltype", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, - "type": "string" + "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.", @@ -93214,33 +93080,27 @@ "type": "boolean" }, { - "description": "lists snapshot by snapshot name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "If set to false, list templates across zones and their storages", "length": 255, - "name": "pagesize", + "name": "showunique", "required": false, - "type": "integer" + "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.", + "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", "length": 255, - "name": "isrecursive", + "name": "locationtype", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "string" }, { - "description": "the ID of the disk volume", + "description": "valid values are MANUAL or RECURRING.", "length": 255, - "name": "volumeid", - "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "snapshottype", "required": false, - "type": "uuid" + "type": "string" }, { "description": "ID of the storage pool", @@ -93252,18 +93112,10 @@ "type": "uuid" }, { - "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": "list only resources belonging to the domain specified", + "description": "the ID of the disk volume", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, "type": "uuid" }, @@ -93275,57 +93127,49 @@ "type": "string" }, { - "description": "List by keyword", + "description": "list snapshots by zone id", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", + "description": "", "length": 255, - "name": "locationtype", + "name": "pagesize", "required": false, - "since": "4.19.0", - "type": "string" + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" } ], "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", "response": [ { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, - { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, { "description": "state of the disk volume", "name": "volumestate", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - {}, - { - "description": "the account associated with the snapshot", - "name": "account", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { @@ -93334,28 +93178,8 @@ "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" - }, - { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" - }, - { - "description": "id of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "ID of the snapshot", - "name": "id", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { @@ -93364,62 +93188,22 @@ "type": "boolean" }, { - "description": "name of the snapshot", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" - }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -93427,14 +93211,19 @@ "name": "domainid", "type": "string" }, + { + "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", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -93442,100 +93231,303 @@ "name": "customer", "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", + "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" } ], "type": "set" }, - {}, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "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": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" + }, + { + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "the project name of the snapshot", + "name": "project", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" + }, + { + "description": "name of the snapshot", + "name": "name", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + {}, + { + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" + }, + {}, + { + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "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": "Lists IPv4 subnets for zone.", + "isasync": false, + "name": "listIpv4SubnetsForZone", + "params": [ + { + "description": "UUID of zone to which the IPv4 subnet belongs to.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "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" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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": "project who which the IPv4 subnet is dedicated to", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + } + ], + "related": "dedicateIpv4SubnetForZone", + "response": [ + { + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, + {}, { - "description": "the status of the template", - "name": "status", + "description": "the domain ID of the IPv4 subnet", + "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 account of the IPv4 subnet", + "name": "account", + "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" } - ] + ], + "since": "4.20.0" }, { "description": "migrates resources from one secondary storage to destination image store", "isasync": true, "name": "migrateResourceToAnotherSecondaryStorage", "params": [ - { - "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, @@ -93552,11 +93544,19 @@ "required": true, "type": "uuid" }, + { + "description": "id(s) of the snapshots to be migrated", + "length": 255, + "name": "snapshots", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", + "required": false, + "type": "list" + }, { "description": "id(s) of the templates to be migrated", "length": 255, "name": "templates", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "list" } @@ -93564,27 +93564,27 @@ "related": "migrateSecondaryStorageData", "response": [ {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Response message from migration of secondary storage data objects", "name": "message", "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "Type of migration requested for", "name": "migrationtype", @@ -93599,10 +93599,17 @@ "name": "deleteSSHKeyPair", "params": [ { - "description": "the project associated with keypair", + "description": "Name of the keypair", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the domain ID associated with the keypair", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, @@ -93614,43 +93621,36 @@ "type": "string" }, { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the domain ID associated with the keypair", + "description": "the project associated with keypair", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "projectid", + "related": "createProject", "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": "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" } ] }, @@ -93659,13 +93659,6 @@ "isasync": false, "name": "searchLdap", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -93680,6 +93673,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "query to search using", "length": 255, @@ -93691,36 +93691,25 @@ ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "The user's email", "name": "email", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "The user's username", + "name": "username", "type": "string" }, {}, { - "description": "The user's lastname", - "name": "lastname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -93729,8 +93718,19 @@ "type": "string" }, { - "description": "The user's username", - "name": "username", + "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": "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" }, { @@ -93757,37 +93757,37 @@ ], "related": "prepareForShutdown", "response": [ - {}, - { - "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 id of the management server", "name": "managementserverid", "type": "long" }, + {}, + {}, { "description": "The number of jobs in progress", "name": "pendingjobscount", "type": "long" }, - {}, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", "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 a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" } ], "since": "4.19.0" @@ -93816,19 +93816,20 @@ "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "response": [ { - "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", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "Tungsten-Fabric logical router uuid", @@ -93836,22 +93837,21 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric logical router name", + "name": "name", "type": "string" }, { - "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" + } ] }, { @@ -93870,33 +93870,190 @@ ], "related": "listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", + "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" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "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": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + {}, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + {}, + { + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, + { + "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "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", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -93905,48 +94062,43 @@ "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 (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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 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 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 name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -93955,43 +94107,38 @@ "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": "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": "the IPv6 address of network", - "name": "ip6address", + "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", + "description": "Type of adapter if available", + "name": "adaptertype", "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { @@ -94000,87 +94147,56 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the corresponding network", + "name": "networkid", "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" } ], "type": "list" }, - {}, - { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" - }, - { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" - }, - { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "Network ID of the shared filesystem", - "name": "networkid", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -94089,44 +94205,18 @@ "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, - {}, - { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "type": "string" - }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { @@ -94135,88 +94225,18 @@ "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, - { - "description": "ID of the shared filesystem", - "name": "id", - "type": "string" - }, - { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "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": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { @@ -94224,86 +94244,66 @@ "name": "tags", "response": [ { - "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "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", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, - { - "description": "the state of the shared filesystem", - "name": "state", - "type": "string" - }, - { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" - }, - { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "the filesystem format", + "name": "filesystem", "type": "string" } ], @@ -94315,31 +94315,38 @@ "name": "createTungstenFabricFirewallRule", "params": [ { - "description": "Tungsten-Fabric firewall rule tag type uuid", + "description": "Tungsten-Fabric firewall rule destination tag uuid", "length": 255, - "name": "tagtypeuuid", + "name": "desttaguuid", "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag uuid", + "description": "Tungsten-Fabric firewall rule service group uuid", "length": 255, - "name": "desttaguuid", - "required": false, + "name": "servicegroupuuid", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination address group uuid", + "description": "the sequence of Tungsten-Fabric firewall rule", "length": 255, - "name": "destaddressgroupuuid", + "name": "sequence", + "required": true, + "type": "integer" + }, + { + "description": "Tungsten-Fabric firewall rule source tag uuid", + "length": 255, + "name": "srctaguuid", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric destination network", + "description": "Tungsten-Fabric firewall rule name", "length": 255, - "name": "destnetworkuuid", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -94350,11 +94357,11 @@ "type": "string" }, { - "description": "the sequence of Tungsten-Fabric firewall rule", + "description": "Tungsten-Fabric firewall rule destination address group uuid", "length": 255, - "name": "sequence", - "required": true, - "type": "integer" + "name": "destaddressgroupuuid", + "required": false, + "type": "string" }, { "description": "the ID of zone", @@ -94365,70 +94372,68 @@ "type": "uuid" }, { - "description": "Tungsten-Fabric firewall rule source tag uuid", - "length": 255, - "name": "srctaguuid", - "required": false, - "type": "string" - }, - { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "Tungsten-Fabric firewall rule direction", "length": 255, - "name": "firewallpolicyuuid", + "name": "direction", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group uuid", + "description": "the uuid of Tungsten-Fabric destination network", "length": 255, - "name": "servicegroupuuid", - "required": true, + "name": "destnetworkuuid", + "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric source network", + "description": "Tungsten-Fabric firewall rule tag type uuid", "length": 255, - "name": "srcnetworkuuid", + "name": "tagtypeuuid", "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", + "description": "Tungsten-Fabric firewall rule action", "length": 255, - "name": "direction", + "name": "action", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "action", + "name": "firewallpolicyuuid", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", + "description": "the uuid of Tungsten-Fabric source network", "length": 255, - "name": "name", - "required": true, + "name": "srcnetworkuuid", + "required": false, "type": "string" } ], "related": "listTungstenFabricFirewallRule", "response": [ { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, {}, @@ -94438,8 +94443,8 @@ "type": "integer" }, { - "description": "Tungsten-Fabric firewall rule uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -94448,24 +94453,19 @@ "type": "long" }, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", "type": "string" }, {}, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", "type": "string" }, { @@ -94474,28 +94474,28 @@ "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" }, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", "type": "string" } ] @@ -94513,17 +94513,24 @@ "type": "string" }, { - "description": "lists configurations by category", + "description": "", "length": 255, - "name": "category", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "description": "", "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,listSwifts,addImageStore", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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" }, @@ -94535,13 +94542,6 @@ "since": "4.18.0", "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the ID of the Domain to update the parameter value for corresponding domain", "length": 255, @@ -94551,20 +94551,20 @@ "type": "uuid" }, { - "description": "lists configuration by parent name (primarily used for UI)", + "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, - "name": "parent", + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "lists configuration by group name (primarily used for UI)", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "group", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { "description": "the ID of the Cluster to update the parameter value for corresponding cluster", @@ -94575,12 +94575,11 @@ "type": "uuid" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "lists configurations by category", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "category", "required": false, - "type": "uuid" + "type": "string" }, { "description": "lists configuration by name", @@ -94590,47 +94589,32 @@ "type": "string" }, { - "description": "lists configuration by group name (primarily used for UI)", + "description": "lists configuration by parent name (primarily used for UI)", "length": 255, - "name": "group", + "name": "parent", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "pagesize", + "name": "imagestoreuuid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" } ], "related": "", "response": [ - { - "description": "the display text of the configuration", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the default value of the configuration", - "name": "defaultvalue", - "type": "string" - }, - { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" - }, { "description": "the group of the configuration", "name": "group", @@ -94641,15 +94625,14 @@ "name": "id", "type": "long" }, - {}, { "description": "the component of the configuration", "name": "component", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, { @@ -94658,13 +94641,18 @@ "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the category of the configuration", + "name": "category", + "type": "string" + }, + { + "description": "the description of the configuration", + "name": "description", "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { @@ -94673,23 +94661,30 @@ "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" + }, + { + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, { @@ -94698,8 +94693,13 @@ "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the subgroup of the configuration", + "name": "subgroup", + "type": "string" + }, + { + "description": "the type of the configuration value", + "name": "type", "type": "string" } ] @@ -94709,21 +94709,6 @@ "isasync": true, "name": "scaleKubernetesCluster", "params": [ - { - "description": "Maximum number of worker nodes in the cluster", - "length": 255, - "name": "maxsize", - "required": false, - "type": "long" - }, - { - "description": "the IDs of the nodes to be removed", - "length": 255, - "name": "nodeids", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": false, - "type": "list" - }, { "description": "the ID of the Kubernetes cluster", "length": 255, @@ -94732,6 +94717,14 @@ "required": true, "type": "uuid" }, + { + "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": "Minimum number of worker nodes in the cluster", "length": 255, @@ -94747,51 +94740,48 @@ "type": "long" }, { - "description": "Whether autoscaling is enabled for the cluster", + "description": "Maximum number of worker nodes in the cluster", "length": 255, - "name": "autoscalingenabled", + "name": "maxsize", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "the IDs of the nodes to be removed", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "nodeids", + "related": "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" + "type": "list" + }, + { + "description": "Whether autoscaling is enabled for the cluster", + "length": 255, + "name": "autoscalingenabled", + "required": false, + "type": "boolean" } ], "related": "createKubernetesCluster,startKubernetesCluster", "response": [ { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" - }, - { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" - }, - { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { @@ -94800,68 +94790,64 @@ "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, + {}, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { @@ -94870,76 +94856,85 @@ "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", - "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 type of the cluster", - "name": "clustertype", - "type": "clustertype" + "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": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "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": "the name of the Kubernetes version for the Kubernetes cluster", @@ -94947,14 +94942,19 @@ "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" + }, + { + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" } ] }, @@ -94963,6 +94963,13 @@ "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, @@ -94970,45 +94977,43 @@ "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "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": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "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 version of template", - "name": "version", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { @@ -95017,13 +95022,23 @@ "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { @@ -95032,18 +95047,18 @@ "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { @@ -95052,8 +95067,8 @@ "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -95062,85 +95077,84 @@ "type": "boolean" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the link local IP address for the router", + "name": "linklocalip", "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "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 router", + "name": "account", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" }, { "description": "the ID of the corresponding public network", @@ -95148,8 +95162,8 @@ "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { @@ -95157,9 +95171,9 @@ "name": "healthcheckresults", "response": [ { - "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", @@ -95167,13 +95181,13 @@ "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 type of the health check - basic or advanced", - "name": "checktype", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { @@ -95185,8 +95199,18 @@ "type": "list" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { @@ -95194,78 +95218,88 @@ "name": "linklocalnetmask", "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": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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 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 gateway of the nic", - "name": "gateway", + "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", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { @@ -95273,24 +95307,34 @@ "name": "broadcasturi", "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 isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -95299,23 +95343,28 @@ "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -95324,61 +95373,56 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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", + "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 type of the nic", - "name": "type", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" } ], "type": "set" }, { - "description": "the gateway for the router", - "name": "gateway", + "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 the code / software in the router", - "name": "softwareversion", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the template name for the router", - "name": "templatename", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -95386,67 +95430,23 @@ "name": "domainid", "type": "string" }, + {}, { - "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": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "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": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - } + {} ] }, { @@ -95465,9 +95465,9 @@ ], "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" }, {}, { @@ -95475,17 +95475,17 @@ "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" + } ] }, { @@ -95493,13 +95493,6 @@ "isasync": true, "name": "updateTrafficType", "params": [ - { - "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": "traffic type id", "length": 255, @@ -95515,6 +95508,13 @@ "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 VMware host", "length": 255, @@ -95523,9 +95523,9 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "xennetworklabel", + "name": "ovm3networklabel", "required": false, "type": "string" }, @@ -95539,35 +95539,46 @@ ], "related": "addTrafficType", "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "id of the network provider", + "name": "id", + "type": "string" + }, { "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 VMware host", - "name": "vmwarenetworklabel", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -95576,21 +95587,10 @@ "type": "integer" }, { - "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", + "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" }, @@ -95600,19 +95600,11 @@ "name": "listConditions", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the ID of the policy", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -95623,32 +95615,32 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Counter-id of the condition.", "length": 255, - "name": "account", + "name": "counterid", + "related": "createCounter", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "ID of the Condition.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "listConditions", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Counter-id of the condition.", + "description": "the ID of the policy", "length": 255, - "name": "counterid", - "related": "createCounter", + "name": "policyid", + "related": "listAutoScalePolicies", "required": false, "type": "uuid" }, @@ -95680,18 +95672,21 @@ "name": "listall", "required": false, "type": "boolean" + }, + { + "description": "ID of the Condition.", + "length": 255, + "name": "id", + "related": "listConditions", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { @@ -95705,24 +95700,28 @@ "type": "string" }, { - "description": "the Name of the Counter.", - "name": "countername", + "description": "the id of the Condition", + "name": "id", "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the Condition", + "name": "project", + "type": "string" }, - {}, { "description": "Threshold Value for the counter.", "name": "threshold", "type": "long" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { @@ -95731,19 +95730,13 @@ "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", - "type": "string" - }, - { - "description": "the domain name of the owner.", - "name": "domain", + "description": "the Name of the Counter.", + "name": "countername", "type": "string" }, - {}, { - "description": "the Id of the Counter.", - "name": "counterid", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, { @@ -95751,16 +95744,23 @@ "name": "account", "type": "string" }, + {}, { - "description": "the id of the Condition", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "path of the domain to which the Condition owner belongs", - "name": "domainpath", + "description": "the Id of the Counter.", + "name": "counterid", "type": "string" - } + }, + { + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" + }, + {} ] }, { @@ -95768,6 +95768,14 @@ "isasync": true, "name": "migrateSecondaryStorageData", "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 destination secondary storage pool(s) to which the templates are to be migrated", "length": 255, @@ -95782,14 +95790,6 @@ "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": "", @@ -95800,15 +95800,14 @@ "type": "integer" }, { - "description": "Response message from migration of secondary storage data objects", - "name": "message", + "description": "Type of migration requested for", + "name": "migrationtype", "type": "string" }, {}, - {}, { - "description": "Type of migration requested for", - "name": "migrationtype", + "description": "Response message from migration of secondary storage data objects", + "name": "message", "type": "string" }, { @@ -95816,6 +95815,7 @@ "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -95841,91 +95841,86 @@ "description": "The ID of the volume", "length": 255, "name": "id", - "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": true, "type": "uuid" } ], - "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "cluster id of the volume", - "name": "clusterid", + "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": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "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": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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 read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "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", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { @@ -95934,145 +95929,159 @@ "type": "date" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "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": "pod id of the volume", - "name": "podid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "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 service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + {}, + { + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, { "description": "an optional field whether to the display the volume to the end user or not.", "name": "displayvolume", "type": "boolean" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -96081,27 +96090,42 @@ "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", + "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, { "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", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -96110,23 +96134,23 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -96134,122 +96158,108 @@ "name": "value", "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", + "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" } ], "type": "set" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "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": "state of the virtual machine", - "name": "vmstate", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, + {}, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the disk utilization", - "name": "utilization", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "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": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { @@ -96258,19 +96268,9 @@ "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" } ], "since": "4.14.0" @@ -96281,38 +96281,38 @@ "name": "addTrafficType", "params": [ { - "description": "the trafficType to be added to the physical network", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "traffictype", - "required": true, + "name": "hypervnetworklabel", + "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "the Physical Network ID", "length": 255, - "name": "xennetworklabel", - "required": false, - "type": "string" + "name": "physicalnetworkid", + "related": "updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, - "name": "ovm3networklabel", + "name": "kvmnetworklabel", "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "the trafficType to be added to the physical network", "length": 255, - "name": "physicalnetworkid", - "related": "updatePhysicalNetwork", + "name": "traffictype", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "The VLAN id to be used for Management traffic by VMware host", "length": 255, - "name": "kvmnetworklabel", + "name": "vlan", "required": false, "type": "string" }, @@ -96324,43 +96324,37 @@ "type": "string" }, { - "description": "The VLAN id to be used for Management traffic by VMware host", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "vlan", + "name": "xennetworklabel", "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'.", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "isolationmethod", + "name": "ovm3networklabel", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "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": "hypervnetworklabel", + "name": "isolationmethod", "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 physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", "type": "string" }, { @@ -96369,13 +96363,13 @@ "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": "id of the network provider", - "name": "id", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "type": "string" }, { @@ -96383,20 +96377,26 @@ "name": "vmwarenetworklabel", "type": "string" }, + {}, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "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 KVM host", - "name": "kvmnetworklabel", + "description": "id of the network provider", + "name": "id", "type": "string" }, - {}, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "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" } ], @@ -96408,26 +96408,26 @@ "name": "listSecondaryStorageSelectors", "params": [ { - "description": "List by keyword", + "description": "The zone ID to be used in the search filter.", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "The zone ID to be used in the search filter.", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", @@ -96437,43 +96437,34 @@ "type": "string" }, { - "description": "", + "description": "Show removed heuristics.", "length": 255, - "name": "pagesize", + "name": "showremoved", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "Show removed heuristics.", + "description": "List by keyword", "length": 255, - "name": "showremoved", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" } ], "related": "", "response": [ - { - "description": "Description of the heuristic.", - "name": "description", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the heuristic.", + "name": "id", "type": "string" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -96484,25 +96475,34 @@ "name": "zoneid", "type": "string" }, + { + "description": "When the heuristic was created.", + "name": "created", + "type": "date" + }, + { + "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 removed.", "name": "removed", "type": "date" }, { - "description": "Name of the heuristic.", - "name": "name", + "description": "Description of the heuristic.", + "name": "description", "type": "string" }, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "ID of the heuristic.", - "name": "id", + "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" } ], @@ -96514,11 +96514,11 @@ "name": "listLoadBalancerRuleInstances", "params": [ { - "description": "true if load balancer rule VM IP information to be included; default is false", + "description": "", "length": 255, - "name": "lbvmips", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", @@ -96528,11 +96528,11 @@ "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -96541,6 +96541,13 @@ "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": "the ID of the load balancer rule", "length": 255, @@ -96548,38 +96555,31 @@ "related": "createPortForwardingRule,updatePortForwardingRule", "required": true, "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "listLoadBalancerRuleInstances", "response": [ - {}, + { + "description": "IP addresses of the vm set of lb rule", + "name": "lbvmipaddresses", + "type": "list" + }, {}, { - "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": "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": "IP addresses of the vm set of lb rule", - "name": "lbvmipaddresses", - "type": "list" + "description": "the user vm set for lb rule", + "name": "loadbalancerruleinstance", + "type": "uservmresponse" } ] }, @@ -96604,21 +96604,21 @@ "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": "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" } ] }, @@ -96628,18 +96628,18 @@ "name": "updatePhysicalNetwork", "params": [ { - "description": "Enabled/Disabled", + "description": "the VLAN for the physical network", "length": 255, - "name": "state", + "name": "vlan", "required": false, "type": "string" }, { - "description": "the VLAN for the physical network", + "description": "Tag the physical network", "length": 255, - "name": "vlan", + "name": "tags", "required": false, - "type": "string" + "type": "list" }, { "description": "physical network id", @@ -96650,11 +96650,11 @@ "type": "uuid" }, { - "description": "Tag the physical network", + "description": "Enabled/Disabled", "length": 255, - "name": "tags", + "name": "state", "required": false, - "type": "list" + "type": "string" }, { "description": "the speed for the physical network[1G/10G]", @@ -96666,40 +96666,35 @@ ], "related": "", "response": [ + {}, { - "description": "comma separated tag", - "name": "tags", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "name of the physical network", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "isolation methods", - "name": "isolationmethods", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the uuid of the physical network", - "name": "id", + "description": "state of the physical network", + "name": "state", "type": "string" }, { @@ -96708,19 +96703,18 @@ "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "state of the physical network", - "name": "state", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { @@ -96729,8 +96723,14 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma separated tag", + "name": "tags", + "type": "string" + }, + {}, + { + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" } ], @@ -96760,23 +96760,28 @@ "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -96784,38 +96789,38 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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 domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -96824,81 +96829,36 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "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": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "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": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the state of the shared filesystem", - "name": "state", - "type": "string" - }, - { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, - { - "description": "Network ID of the shared filesystem", - "name": "networkid", - "type": "string" - }, { "description": "name of the storage fs data volume", "name": "volumename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { @@ -96906,44 +96866,29 @@ "name": "id", "type": "string" }, - { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "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 name of the corresponding network", - "name": "networkname", + "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { "description": "the traffic type of the nic", @@ -96951,58 +96896,63 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "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", + "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", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "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 gateway of IPv6 network", "name": "ip6gateway", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -97011,48 +96961,53 @@ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -97061,36 +97016,31 @@ "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the netmask of the nic", + "name": "netmask", "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" } ], "type": "list" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { @@ -97098,30 +97048,49 @@ "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "description of the shared filesystem", - "name": "description", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "ID of the storage fs vm", + "name": "vmstate", + "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 domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { @@ -97130,18 +97099,28 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { @@ -97150,49 +97129,70 @@ "type": "string" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "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": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, {}, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" } ], @@ -97213,23 +97213,23 @@ } ], "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 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", @@ -97242,13 +97242,6 @@ "isasync": false, "name": "listTungstenFabricFirewallRule", "params": [ - { - "description": "the uuid of Tungsten-Fabric firewall rule", - "length": 255, - "name": "firewallruleuuid", - "required": false, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -97258,11 +97251,11 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "", "length": 255, - "name": "firewallpolicyuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -97272,103 +97265,110 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "keyword", + "name": "firewallpolicyuuid", + "required": false, + "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric firewall rule", + "length": 255, + "name": "firewallruleuuid", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule uuid", - "name": "uuid", + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "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 firewall rule source tag", - "name": "srctag", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", + "type": "string" } ] }, @@ -97387,9 +97387,9 @@ "type": "uuid" }, { - "description": "The display text of the project, defaults to the 'name´.", + "description": "account who will be Admin for the project", "length": 255, - "name": "displaytext", + "name": "account", "required": false, "type": "string" }, @@ -97402,17 +97402,9 @@ "type": "uuid" }, { - "description": "domain ID of the account owning a project", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "account who will be Admin for the project", + "description": "The display text of the project, defaults to the 'name´.", "length": 255, - "name": "account", + "name": "displaytext", "required": false, "type": "string" }, @@ -97422,268 +97414,311 @@ "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" } ], "related": "", "response": [ { - "description": "the name of the project", - "name": "name", - "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 date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "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", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "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 total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" }, { "description": "the state of the project", "name": "state", "type": "string" }, - {}, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "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 have been created by this project", - "name": "templatetotal", + "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 total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the id of the project", + "name": "id", "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 that can be deployed by this project", + "name": "vmlimit", + "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, + {}, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the id of the project", - "name": "id", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + {}, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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 account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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 project id the tag belongs to", - "name": "projectid", + "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 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": "resource type", - "name": "resourcetype", + "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": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "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 vpcs the project can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { "description": "the total number of snapshots which can be stored by this project", @@ -97691,44 +97726,9 @@ "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" } ], "since": "3.0.0" @@ -97739,45 +97739,45 @@ "name": "assignCertToLoadBalancer", "params": [ { - "description": "the ID of the certificate", + "description": "the ID of the load balancer rule", "length": 255, - "name": "certid", - "related": "", + "name": "lbruleid", + "related": "createPortForwardingRule,updatePortForwardingRule", "required": true, "type": "uuid" }, { - "description": "the ID of the load balancer rule", + "description": "the ID of the certificate", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,updatePortForwardingRule", + "name": "certid", + "related": "", "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": "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": "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" - } + {} ] }, { @@ -97788,7 +97788,14 @@ { "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "password", + "name": "username", + "required": true, + "type": "string" + }, + { + "description": "Hostname or ip address of the Cisco VNMC Controller.", + "length": 255, + "name": "hostname", "required": true, "type": "string" }, @@ -97803,36 +97810,29 @@ { "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "username", - "required": true, - "type": "string" - }, - { - "description": "Hostname or ip address of the Cisco VNMC Controller.", - "length": 255, - "name": "hostname", + "name": "password", "required": true, "type": "string" } ], "related": "listCiscoVnmcResources", "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" }, {}, - {}, {} ] }, @@ -97842,18 +97842,18 @@ "name": "markDefaultZoneForAccount", "params": [ { - "description": "Marks the account that belongs to the specified domain.", + "description": "The Zone ID with which the account is to be marked.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "The Zone ID with which the account is to be marked.", + "description": "Marks the account that belongs to the specified domain.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": true, "type": "uuid" }, @@ -97869,106 +97869,211 @@ "related": "disableAccount,enableAccount,updateAccount,listAccounts", "response": [ { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "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 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 user email address", + "name": "email", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the 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 domain name of the user", + "name": "domain", + "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 secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, - {}, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "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", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "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 available for this account", - "name": "snapshotavailable", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, - {}, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { "description": "the total number of virtual machines stopped for this account", @@ -97976,9 +98081,9 @@ "type": "integer" }, { - "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": "details for the account", @@ -97986,28 +98091,18 @@ "type": "map" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, - { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "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 network domain", + "name": "networkdomain", "type": "string" }, { @@ -98016,39 +98111,34 @@ "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 owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { "description": "the total number of vpcs available to be created for this account", @@ -98056,165 +98146,49 @@ "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" }, + {}, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "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": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "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 date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "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 domain ID of the user", - "name": "domainid", - "type": "string" - } - ], - "type": "list" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { - "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", + "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "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": "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 cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { @@ -98223,58 +98197,73 @@ "type": "date" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the name of the account", - "name": "name", + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "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 available for this account to acquire", - "name": "ipavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "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 primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "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 this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { @@ -98283,25 +98272,36 @@ "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + { + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.0" }, @@ -98318,43 +98318,43 @@ "type": "string" }, { - "description": "The certificate serial number, as a hex value", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "serial", - "required": true, + "name": "provider", + "required": false, "type": "string" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "The certificate serial number, as a hex value", "length": 255, - "name": "provider", - "required": false, + "name": "serial", + "required": true, "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": "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": "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" }, @@ -98378,23 +98378,23 @@ "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ], "since": "4.20.0" }, @@ -98403,6 +98403,13 @@ "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 service offering ID to apply to the system vm", "length": 255, @@ -98411,13 +98418,6 @@ "required": true, "type": "uuid" }, - { - "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, @@ -98430,58 +98430,58 @@ "related": "startSystemVm", "response": [ { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "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 systemvm agent version", - "name": "version", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { @@ -98490,24 +98490,19 @@ "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the state of the system VM", + "name": "state", "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 hostname for the system VM", @@ -98515,59 +98510,54 @@ "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", - "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 system VM", - "name": "name", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the system VM", - "name": "state", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "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 systemvm agent version", + "name": "version", + "type": "string" }, + {}, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { @@ -98576,28 +98566,29 @@ "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the host ID for the system VM", + "name": "hostid", "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 Zone ID for the system VM", + "name": "zoneid", + "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { @@ -98605,30 +98596,29 @@ "name": "linklocalip", "type": "string" }, - {}, { - "description": "the ID of the system VM", - "name": "id", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { @@ -98637,9 +98627,19 @@ "type": "integer" }, { - "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 for the system VM", + "name": "templateid", + "type": "string" + }, + { + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" } ] }, @@ -98648,21 +98648,6 @@ "isasync": false, "name": "updateSiocInfo", "params": [ - { - "description": "Zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "Shares per GB", - "length": 255, - "name": "sharespergb", - "required": true, - "type": "integer" - }, { "description": "Notify if IOPS above this value", "length": 255, @@ -98684,27 +98669,42 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" + }, + { + "description": "Zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Shares per GB", + "length": 255, + "name": "sharespergb", + "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" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.11.0" }, @@ -98723,16 +98723,6 @@ } ], "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" - }, {}, {}, { @@ -98744,6 +98734,16 @@ "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.2.0" @@ -98757,34 +98757,34 @@ "description": "The ID of the virtual machine to unmanage", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "related": "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "details of the unmanage VM operation", "name": "details", "type": "string" }, - {}, + { + "description": "result of the unmanage VM operation", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "result of the unmanage VM operation", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, {} ], "since": "4.15.0" @@ -98794,14 +98794,6 @@ "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, @@ -98809,109 +98801,31 @@ "required": false, "since": "4.16.0", "type": "boolean" + }, + { + "description": "the ID of the router", + "length": 255, + "name": "id", + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" } ], "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "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 link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - {}, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, { "description": "the guest IP address for the router", "name": "guestipaddress", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { @@ -98919,9 +98833,9 @@ "name": "nic", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the gateway of the nic", @@ -98929,78 +98843,73 @@ "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "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": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "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 NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "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" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -99009,28 +98918,28 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "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 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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -99039,77 +98948,102 @@ "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the IPv6 address of network", + "name": "ip6address", "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": "Type of adapter if available", - "name": "adaptertype", + "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", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], "type": "set" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { "description": "the Pod ID for the router", @@ -99117,69 +99051,108 @@ "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, - {}, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -99192,9 +99165,9 @@ "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", @@ -99202,83 +99175,110 @@ "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 this VPC was created", - "name": "lastupdated", - "type": "date" } ], "type": "list" }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, { "description": "the Pod name for the router", "name": "podname", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the hostname for the router", - "name": "hostname", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the account associated with the router", + "name": "account", "type": "string" - } + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + {} ] }, { @@ -99287,26 +99287,26 @@ "name": "listNics", "params": [ { - "description": "the ID of the nic to list IPs", + "description": "List by keyword", "length": 255, - "name": "nicid", - "related": "listNics", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "keyword", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the ID of the vm", + "description": "the ID of the nic to list IPs", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, + "name": "nicid", + "related": "listNics", + "required": false, "type": "uuid" }, { @@ -99323,14 +99323,6 @@ "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": "list nic of the specific vm's network", "length": 255, @@ -99338,38 +99330,41 @@ "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "type": "uuid" + }, + { + "description": "the ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "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": "the ip address of the nic", - "name": "ipaddress", - "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 traffic type of the nic", - "name": "traffictype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -99377,83 +99372,93 @@ "name": "isolatedpvlantype", "type": "string" }, + {}, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "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", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the traffic type of the nic", + "name": "traffictype", "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": "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -99465,49 +99470,44 @@ "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ] }, @@ -99515,14 +99515,7 @@ "description": "Lists Bgp Peers.", "isasync": false, "name": "listBgpPeers", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, + "params": [ { "description": "", "length": 255, @@ -99531,17 +99524,17 @@ "type": "integer" }, { - "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", + "description": "AS number of the Bgp Peer.", "length": 255, - "name": "account", + "name": "asnumber", "required": false, - "type": "string" + "type": "long" }, { - "description": "the domain ID which the Bgp Peer is dedicated to.", + "description": "UUID of zone to which the Bgp Peer belongs to.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, @@ -99554,18 +99547,11 @@ "type": "uuid" }, { - "description": "AS number of the Bgp Peer.", - "length": 255, - "name": "asnumber", - "required": false, - "type": "long" - }, - { - "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.", + "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", "length": 255, - "name": "isdedicated", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "UUID of the Bgp Peer.", @@ -99576,13 +99562,27 @@ "type": "uuid" }, { - "description": "UUID of zone to which the Bgp Peer belongs to.", + "description": "the domain ID which the Bgp Peer is dedicated to.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, + { + "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": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -99594,8 +99594,8 @@ "related": "releaseBgpPeer", "response": [ { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { @@ -99615,23 +99615,18 @@ "type": "date" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "password of bgp peer", + "name": "password", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "IPv4 address of bgp peer", "name": "ipaddress", "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { @@ -99640,13 +99635,13 @@ "type": "map" }, { - "description": "password of bgp peer", - "name": "password", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { @@ -99655,24 +99650,29 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, - {}, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account of the bgp peer", + "name": "account", "type": "string" } ], @@ -99683,13 +99683,6 @@ "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, @@ -99702,41 +99695,105 @@ "description": "The ID of the disk volume", "length": 255, "name": "volumeid", - "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": true, "type": "uuid" + }, + { + "description": "the name of the snapshot", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "copySnapshot,archiveSnapshot,listSnapshots", "response": [ { - "description": "id of the availability zone", - "name": "zoneid", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "name of the snapshot", + "name": "name", + "type": "string" + }, + {}, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + }, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, + {}, { "description": "state of the snapshot on the datastore", "name": "datastorestate", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { @@ -99745,47 +99802,72 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, + { + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", "type": "boolean" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" }, { "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -99794,41 +99876,36 @@ "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", + "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 account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "name of the snapshot", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { @@ -99836,107 +99913,30 @@ "name": "virtualsize", "type": "long" }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" - }, - { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "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": "display name of the os on volume", "name": "osdisplayname", "type": "string" }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "ID of the snapshot", - "name": "id", - "type": "string" - }, - { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" - }, - {}, - {}, - { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" - }, - { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "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" - }, { "description": "the status of the template", "name": "status", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "id of the os on volume", + "name": "ostypeid", "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 domain name of the snapshot's account", - "name": "domain", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" } ], "since": "4.10.0" @@ -99946,6 +99946,13 @@ "isasync": false, "name": "listImageStoreObjects", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "path to list on image store", "length": 255, @@ -99953,6 +99960,13 @@ "required": false, "type": "string" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "id of the image store", "length": 255, @@ -99967,48 +99981,28 @@ "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": "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": "Size is in Bytes.", + "name": "size", + "type": "long" }, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "Volume ID associated with the data store object.", + "name": "volumeid", "type": "string" }, - {}, { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", + "description": "Volume Name associated with the data store object.", + "name": "volumename", "type": "string" }, { - "description": "Snapshot Name associated with the data store object.", - "name": "snapshotname", + "description": "Format of template associated with the data store object.", + "name": "format", "type": "string" }, { @@ -100017,19 +100011,24 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Template ID associated with the data store object.", + "name": "templateid", "type": "string" }, { - "description": "Template ID associated with the data store object.", - "name": "templateid", + "description": "Template Name associated with the data store object.", + "name": "templatename", "type": "string" }, { - "description": "Size is in Bytes.", - "name": "size", - "type": "long" + "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": "Name of the data store object.", @@ -100037,21 +100036,22 @@ "type": "string" }, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", + "type": "string" }, + {}, { - "description": "Format of template associated with the data store object.", - "name": "format", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Volume Name associated with the data store object.", - "name": "volumename", + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", "type": "string" - } + }, + {} ], "since": "4.19.0" }, @@ -100061,12 +100061,11 @@ "name": "dedicateGuestVlanRange", "params": [ { - "description": "physical network ID of the vlan", + "description": "guest vlan range to be dedicated", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "vlanrange", "required": true, - "type": "uuid" + "type": "string" }, { "description": "project who will own the VLAN", @@ -100077,11 +100076,12 @@ "type": "uuid" }, { - "description": "guest vlan range to be dedicated", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "vlanrange", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { "description": "account who will own the VLAN", @@ -100091,26 +100091,52 @@ "type": "string" }, { - "description": "domain ID of the account owning a VLAN", + "description": "physical network ID of the vlan", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, + "name": "physicalnetworkid", + "related": "", + "required": true, "type": "uuid" } ], "related": "", "response": [ + { + "description": "the project name of the guest vlan range", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" + }, { "description": "the ID of the guest VLAN range", "name": "id", "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": "the zone of the guest vlan range", + "name": "zoneid", + "type": "long" + }, { "description": "the physical network of the guest vlan range", "name": "physicalnetworkid", @@ -100121,28 +100147,11 @@ "name": "domainid", "type": "string" }, - { - "description": "the project name of the guest vlan range", - "name": "project", - "type": "string" - }, - { - "description": "the project id of the guest vlan range", - "name": "projectid", - "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 UUID of the latest async job acting on this object", "name": "jobid", @@ -100153,16 +100162,7 @@ "name": "guestvlanrange", "type": "string" }, - { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" - }, - { - "description": "the domain name of the guest VLAN range", - "name": "domain", - "type": "string" - } + {} ] }, { @@ -100171,81 +100171,81 @@ "name": "updateIso", "params": [ { - "description": "the format for the image", + "description": "the ID of the image file", "length": 255, - "name": "format", - "required": false, - "type": "string" + "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": "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": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "cleanupdetails", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "arch", + "name": "passwordenabled", "required": false, - "since": "4.20", - "type": "string" + "type": "boolean" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "passwordenabled", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the ID of the image file", + "description": "sort key of the template, integer", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "isdynamicallyscalable", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { - "description": "the name of the image file", + "description": "the format for the image", "length": 255, - "name": "name", + "name": "format", "required": false, "type": "string" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "details", + "name": "bootable", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "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": "string" + "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "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": "isrouting", + "name": "cleanupdetails", "required": false, "type": "boolean" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "bootable", + "name": "isrouting", "required": false, "type": "boolean" }, @@ -100258,11 +100258,11 @@ "type": "uuid" }, { - "description": "sort key of the template, integer", + "description": "the name of the image file", "length": 255, - "name": "sortkey", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", @@ -100272,95 +100272,137 @@ "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, - {}, { "description": "true if template requires HVM enabled, false otherwise", "name": "requireshvm", "type": "boolean" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the URL which the template/iso is registered from", + "name": "url", "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 processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "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": "checksum of the template", - "name": "checksum", + "description": "the id of userdata linked to this template", + "name": "userdataid", "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 template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "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": "resource type", + "name": "resourcetype", + "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": "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 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": "CPU Arch of the template", - "name": "arch", - "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 ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -100368,84 +100410,83 @@ "type": "integer" }, { - "description": "the type of the template", - "name": "templatetype", - "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": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, - {}, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "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 name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "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 ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "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" }, { @@ -100454,24 +100495,24 @@ "type": "boolean" }, { - "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": "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": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the ID of the zone for this template", + "name": "zoneid", + "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": "path of the Domain the template belongs to", @@ -100479,110 +100520,58 @@ "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "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": "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": "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 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 domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { @@ -100590,35 +100579,46 @@ "name": "downloaddetails", "type": "list" }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, { "description": "the physical size of the template", "name": "physicalsize", "type": "long" }, + {}, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "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 format of the template.", + "name": "format", + "type": "imageformat" }, { "description": "true if the ISO is bootable, false otherwise", "name": "bootable", "type": "boolean" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" } ] }, @@ -100637,23 +100637,23 @@ } ], "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", @@ -100667,19 +100667,12 @@ "name": "issueCertificate", "params": [ { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "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": "provider", + "name": "domain", "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": "Comma separated list of IP addresses, the certificate should be issued for", "length": 255, @@ -100692,12 +100685,19 @@ "length": 65535, "name": "csr", "required": false, - "type": "string" + "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": "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", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "domain", + "name": "provider", "required": false, "type": "string" } @@ -100705,32 +100705,32 @@ "related": "listCaCertificate", "response": [ { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The client certificate", - "name": "certificate", - "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" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The client certificate", + "name": "certificate", + "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The CA certificate(s)", + "name": "cacertificates", "type": "string" - } + }, + {} ], "since": "4.11.0" }, @@ -100740,63 +100740,69 @@ "name": "createPortForwardingRule", "params": [ { - "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", + "description": "the IP address id of the port forwarding rule", "length": 255, - "name": "openfirewall", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "length": 255, + "name": "privateendport", "required": false, - "type": "boolean" + "type": "integer" }, { - "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).", + "description": "the ending port of port forwarding rule's private port range", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "publicendport", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "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 virtual machine for the port forwarding rule", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "related": "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": "the starting port of port forwarding rule's public port range", + "description": "VM guest nic secondary IP address for the port forwarding rule", "length": 255, - "name": "publicport", - "required": true, - "type": "integer" + "name": "vmguestip", + "required": false, + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "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": "fordisplay", + "name": "openfirewall", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "VM guest nic secondary IP address for the port forwarding rule", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "vmguestip", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the IP address id of the port forwarding rule", + "description": "the starting port of port forwarding rule's public port range", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "publicport", "required": true, - "type": "uuid" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "length": 255, - "name": "publicendport", - "required": false, "type": "integer" }, { @@ -100807,18 +100813,12 @@ "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": "the ending port of port forwarding rule's private port range", + "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": "privateendport", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the starting port of port forwarding rule's private port range", @@ -100831,94 +100831,129 @@ "related": "updatePortForwardingRule", "response": [ { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "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 state of the rule", - "name": "state", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, {}, + {}, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "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": "publicendport", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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", + "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 protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "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 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 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 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": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -100927,13 +100962,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -100945,234 +100980,165 @@ "type": "list" }, { - "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 ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "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", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" } ] }, { - "description": "Dedicates a zones.", - "isasync": true, - "name": "dedicateZone", + "description": "load template into primary storage", + "isasync": false, + "name": "prepareTemplate", "params": [ { - "description": "the ID of the zone", + "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": "zoneid", - "related": "listZones", - "required": true, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, "type": "uuid" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "zone ID of the template to be prepared in primary storage(s).", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the ID of the containing domain", + "description": "template ID of the template to be prepared in primary storage(s).", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "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": "", + "related": "listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the Name of the Zone", - "name": "zonename", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", - "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 ID of the dedicated resource", - "name": "id", + "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 domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, {}, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "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 status of the template", + "name": "status", "type": "string" - } - ] - }, - { - "description": "load template into primary storage", - "isasync": false, - "name": "prepareTemplate", - "params": [ - { - "description": "template ID of the template to be prepared in primary storage(s).", - "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "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": "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" - } - ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "response": [ - { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the name of the OS type for this template.", + "name": "ostypename", "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": "CPU Arch of the template", "name": "arch", "type": "string" }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, { "description": "true if this template is a public template, false otherwise", "name": "ispublic", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "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": "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": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, + {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the physical size of the template", + "name": "physicalsize", + "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 template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { "description": "the size of the template", @@ -101180,9 +101146,14 @@ "type": "long" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { "description": "the format of the template.", @@ -101190,24 +101161,23 @@ "type": "imageformat" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, - {}, { - "description": "the status of the template", - "name": "status", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { @@ -101215,82 +101185,72 @@ "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { "description": "the current status of the latest async job acting on this object", @@ -101298,78 +101258,73 @@ "type": "integer" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "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": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "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 the template is managed across all Zones, false otherwise", - "name": "crossZones", + "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 zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "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": "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": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { @@ -101378,59 +101333,104 @@ "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the template name", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "Dedicates a zones.", + "isasync": true, + "name": "dedicateZone", + "params": [ + { + "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" }, { - "description": "the template ID", + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the dedicated resource", "name": "id", "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": "checksum of the template", - "name": "checksum", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", "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 Name of the Zone", + "name": "zonename", + "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -101440,19 +101440,18 @@ "name": "listBuckets", "params": [ { - "description": "the IDs of the Buckets, mutually exclusive with id", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "ids", - "related": "listBuckets", + "name": "tags", "required": false, - "type": "list" + "type": "map" }, { - "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": "", @@ -101461,13 +101460,6 @@ "required": false, "type": "integer" }, - { - "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, @@ -101476,13 +101468,27 @@ "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, + { + "description": "the name of the bucket", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the ID of the object storage pool, available to ROOT admin only", "length": 255, @@ -101492,11 +101498,12 @@ "type": "uuid" }, { - "description": "the name of the bucket", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "name", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -101514,83 +101521,56 @@ "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 tags (key/value pairs)", + "description": "the IDs of the Buckets, mutually exclusive with id", "length": 255, - "name": "tags", + "name": "ids", + "related": "listBuckets", "required": false, - "type": "map" + "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": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "", "response": [ { - "description": "Bucket Quota in GB", - "name": "quota", - "type": "integer" - }, - { - "description": "Bucket Versioning", - "name": "versioning", - "type": "boolean" - }, - { - "description": "the project id of the bucket", - "name": "projectid", - "type": "string" - }, - { - "description": "Bucket Secret Key", - "name": "usersecretkey", - "type": "string" - }, - { - "description": "the account associated with the Bucket", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the bucket", - "name": "project", + "description": "Bucket Access Key", + "name": "accesskey", "type": "string" }, { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "State of the Bucket", - "name": "state", + "description": "ID of the Bucket", + "name": "id", "type": "string" }, { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" + "description": "the date the Bucket was created", + "name": "created", + "type": "date" }, { - "description": "Bucket Access Policy", - "name": "policy", - "type": "string" + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" }, { - "description": "ID of the Bucket", - "name": "id", + "description": "Object storage provider", + "name": "provider", "type": "string" }, { @@ -101598,13 +101578,13 @@ "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 project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -101612,14 +101592,19 @@ "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": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -101628,13 +101613,13 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -101643,48 +101628,204 @@ "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 project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the domain associated with the bucket", - "name": "domain", + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "name of the Bucket", + "name": "name", + "type": "string" + }, + {}, + { + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", + "type": "string" + }, + { + "description": "Bucket Access Policy", + "name": "policy", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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": "Bucket URL", + "name": "url", + "type": "string" + }, + { + "description": "Bucket Quota in GB", + "name": "quota", + "type": "integer" + }, + { + "description": "the account associated with the Bucket", + "name": "account", + "type": "string" + }, + { + "description": "State of the Bucket", + "name": "state", + "type": "string" + }, + { + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" + }, + { + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", + "type": "string" + }, + { + "description": "the domain associated with the bucket", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the bucket", + "name": "domainid", + "type": "string" + }, + { + "description": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" + }, + { + "description": "Bucket Secret Key", + "name": "usersecretkey", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Stops an Internal LB vm.", + "isasync": true, + "name": "stopInternalLoadBalancerVM", + "params": [ + { + "description": "the ID of the internal lb vm", + "length": 255, + "name": "id", + "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "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": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "response": [ + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "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": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the ID of the domain associated with the bucket", + "description": "the domain ID associated with the router", "name": "domainid", "type": "string" }, { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" }, - {}, { - "description": "Bucket Object Locking", - "name": "objectlocking", - "type": "boolean" + "description": "the Pod name for the router", + "name": "podname", + "type": "string" }, - {}, { - "description": "Bucket URL", - "name": "url", + "description": "the id of the router", + "name": "id", "type": "string" }, { @@ -101693,84 +101834,64 @@ "type": "string" }, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "Bucket Access Key", - "name": "accesskey", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "Object storage provider", - "name": "provider", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "name of the Bucket", - "name": "name", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, + {}, { - "description": "path of the domain to which the bucket belongs", - "name": "domainpath", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.19.0" - }, - { - "description": "Stops an Internal LB vm.", - "isasync": true, - "name": "stopInternalLoadBalancerVM", - "params": [ - { - "description": "the ID of the internal lb vm", - "length": 255, - "name": "id", - "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" }, { - "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": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "response": [ - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the version of template", + "name": "version", "type": "string" }, { @@ -101779,65 +101900,54 @@ "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the version of template", - "name": "version", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the link local IP address for the router", + "name": "linklocalip", "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 type of the health check - basic or advanced", "name": "checktype", "type": "string" }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, { "description": "the date this VPC was created", "name": "lastupdated", @@ -101847,102 +101957,87 @@ "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" } ], "type": "list" }, { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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": "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", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -101950,193 +102045,142 @@ "name": "nsxlogicalswitchport", "type": "string" }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, { "description": "the IPv6 address of network", "name": "ip6address", "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "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", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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", + "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 ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "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 ID of the corresponding network", + "name": "networkid", + "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ip address of the nic", + "name": "ipaddress", "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 gateway of the nic", - "name": "gateway", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "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 (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "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", + "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 ID of the nic", + "name": "id", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of the nic", + "name": "gateway", "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" } ], "type": "set" }, - {}, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, { "description": "the name of VPC the router belongs to", "name": "vpcname", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { @@ -102145,78 +102189,34 @@ "type": "date" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "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 guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "path of the Domain the router belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "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", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, + {}, { - "description": "the account associated with the router", - "name": "account", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" } ] @@ -102226,14 +102226,6 @@ "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, @@ -102248,64 +102240,25 @@ "related": "updateSecurityGroup", "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 project name of the group", - "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 group", - "name": "projectid", - "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 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 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", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -102313,13 +102266,13 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -102328,13 +102281,13 @@ "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" }, { @@ -102343,46 +102296,46 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "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", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -102391,14 +102344,14 @@ "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 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", @@ -102406,55 +102359,112 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], "type": "set" }, + { + "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 domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "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 description of the security group", + "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 group", + "name": "project", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "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": "the project name where tag belongs to", + "name": "project", "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 project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -102463,45 +102473,50 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 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", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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", + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -102509,18 +102524,28 @@ "name": "icmpcode", "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 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 key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -102529,23 +102554,23 @@ "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 id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" }, { @@ -102554,13 +102579,13 @@ "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 value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -102570,44 +102595,19 @@ } ], "type": "set" - }, - { - "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 id of the security group rule", - "name": "ruleid", - "type": "string" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" } ], "since": "4.14.0.0" @@ -102617,6 +102617,14 @@ "isasync": false, "name": "createDomain", "params": [ + { + "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": "Network domain for networks in the domain", "length": 255, @@ -102631,14 +102639,6 @@ "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, @@ -102650,75 +102650,81 @@ "related": "listDomains,listDomains", "response": [ { - "description": "the ID of the domain", - "name": "id", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" + "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 projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "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": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "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 primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" }, - {}, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, + {}, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { "description": "the domain name of the parent domain", @@ -102726,39 +102732,39 @@ "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the state of the domain", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "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 number of networks the domain can own", @@ -102766,134 +102772,118 @@ "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" - }, - {}, - { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "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 memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { @@ -102901,15 +102891,25 @@ "name": "taggedresources", "type": "list" }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" + }, { "description": "the total number of templates which can be created by this domain", "name": "templatelimit", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the name of the domain", + "name": "name", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" } ] }, @@ -102919,16 +102919,24 @@ "name": "addImageStore", "params": [ { - "description": "the name for the image store", + "description": "the Zone ID for the image store", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the URL for the image store", - "length": 2048, - "name": "url", + "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 name for the image store", + "length": 255, + "name": "name", "required": false, "type": "string" }, @@ -102940,32 +102948,25 @@ "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", + "description": "the URL for the image store", + "length": 2048, + "name": "url", "required": false, - "type": "uuid" + "type": "string" } ], "related": "addSecondaryStorage,listSwifts", "response": [ { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, + {}, { - "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 Zone ID of the image store", @@ -102973,26 +102974,15 @@ "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", - "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 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", @@ -103003,6 +102993,27 @@ "name": "id", "type": "string" }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + {}, + { + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the host's currently used disk size", "name": "disksizeused", @@ -103017,17 +103028,6 @@ "description": "the name of the image store", "name": "name", "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" } ], "since": "4.2.0" @@ -103037,14 +103037,6 @@ "isasync": false, "name": "revokeTemplateDirectDownloadCertificate", "params": [ - { - "description": "(optional) zone to revoke certificate", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, { "description": "(optional) the host ID to revoke certificate", "length": 255, @@ -103054,12 +103046,11 @@ "type": "uuid" }, { - "description": "id of the certificate", + "description": "(optional) hypervisor type", "length": 255, - "name": "id", - "related": "listTemplateDirectDownloadCertificates", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { "description": "(optional) alias of the SSL certificate", @@ -103069,46 +103060,55 @@ "type": "string" }, { - "description": "(optional) hypervisor type", + "description": "id of the certificate", "length": 255, - "name": "hypervisor", + "name": "id", + "related": "listTemplateDirectDownloadCertificates", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "(optional) zone to revoke certificate", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "provisionTemplateDirectDownloadCertificate", "response": [ { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the host", + "name": "hostname", "type": "string" }, + {}, + {}, { "description": "the ID of the host", "name": "hostid", "type": "string" }, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "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", + "description": "indicates the details in case of failure or host skipped", + "name": "details", "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.13" @@ -103130,58 +103130,63 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "response": [ { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { @@ -103190,40 +103195,38 @@ "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the storage pool path", + "name": "path", + "type": "string" }, - {}, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, - {}, { - "description": "the storage pool path", - "name": "path", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { @@ -103232,24 +103235,26 @@ "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, + {}, { - "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 host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "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": "the overprovisionfactor for the storage pool", @@ -103257,23 +103262,18 @@ "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the ID of the storage pool", - "name": "id", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { @@ -103282,14 +103282,14 @@ "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" } ], "since": "4.16.0" @@ -103311,7 +103311,7 @@ "description": "The ID of the volume to be reassigned.", "length": 255, "name": "volumeid", - "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": true, "type": "uuid" }, @@ -103324,206 +103324,167 @@ "type": "uuid" } ], - "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", "response": [ { - "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": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "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 volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "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": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the status of the volume", - "name": "status", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "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", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, + {}, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "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 disk volume", - "name": "id", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "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 disk volume", - "name": "domainid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { @@ -103531,164 +103492,109 @@ "name": "virtualsize", "type": "long" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "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": "cluster id of the volume", "name": "clusterid", "type": "string" }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - {}, { "description": "bytes write rate of the disk volume", "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", - "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": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "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 account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -103697,26 +103603,41 @@ "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { @@ -103725,8 +103646,48 @@ "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { @@ -103735,16 +103696,55 @@ "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 template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "details for the volume check result, they may vary for different hypervisors", "name": "volumecheckresult", @@ -103758,6 +103758,14 @@ "isasync": false, "name": "deleteUserData", "params": [ + { + "description": "an optional project for the userdata", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "the ID of the Userdata", "length": 255, @@ -103767,10 +103775,10 @@ "type": "uuid" }, { - "description": "an optional project for the userdata", + "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, "type": "uuid" }, @@ -103780,14 +103788,6 @@ "name": "account", "required": false, "type": "string" - }, - { - "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" } ], "response": [ @@ -103796,21 +103796,21 @@ "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" - }, {}, {}, { - "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" } ], @@ -103822,16 +103822,9 @@ "name": "listSupportedNetworkServices", "params": [ { - "description": "network service name to list providers and capabilities of", - "length": 255, - "name": "service", - "required": false, - "type": "string" - }, - { - "description": "network service provider name", + "description": "List by keyword", "length": 255, - "name": "provider", + "name": "keyword", "required": false, "type": "string" }, @@ -103850,9 +103843,16 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "network service provider name", "length": 255, - "name": "keyword", + "name": "provider", + "required": false, + "type": "string" + }, + { + "description": "network service name to list providers and capabilities of", + "length": 255, + "name": "service", "required": false, "type": "string" } @@ -103860,71 +103860,38 @@ "related": "", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the service name", + "name": "name", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "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": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "the provider name", "name": "name", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -103933,12 +103900,45 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "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" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -103959,25 +103959,25 @@ ], "response": [ {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -104021,20 +104021,22 @@ "related": "listTrafficTypes", "response": [ { - "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": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "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", @@ -104045,27 +104047,25 @@ "name": "id", "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": "services for this provider", "name": "servicelist", "type": "list" }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "since": "3.0.0" @@ -104085,17 +104085,18 @@ } ], "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": "any text associated with the success or failure", "name": "displaytext", @@ -104105,8 +104106,7 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ] }, { @@ -104129,23 +104129,23 @@ "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {} ], "since": "4.18.0.0" }, @@ -104155,52 +104155,47 @@ "name": "createServiceOffering", "params": [ { - "description": "max iops of the compute offering", + "description": "The display text of the service offering, defaults to 'name'.", "length": 255, - "name": "maxiops", + "name": "displaytext", "required": false, - "since": "4.4", - "type": "long" + "type": "string" }, { - "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", + "description": "the ID of the disk offering to which service offering should be mapped", "length": 255, - "name": "isvolatile", + "name": "diskofferingid", + "related": "", "required": false, - "type": "boolean" + "since": "4.17", + "type": "uuid" }, { - "description": "The display text of the service offering, defaults to 'name'.", + "description": "restrict the CPU usage to committed service offering", "length": 255, - "name": "displaytext", + "name": "limitcpuuse", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "description": "the CPU number of the service offering", "length": 255, - "name": "networkrate", + "name": "cpunumber", "required": false, "type": "integer" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "type": "long" - }, - { - "description": "details for planner, used to store specific parameters", + "description": "Whether service offering size is custom or not", "length": 255, - "name": "serviceofferingdetails", + "name": "customized", "required": false, - "type": "map" + "since": "4.13", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "byteswriteratemaxlength", + "name": "byteswriteratemax", "required": false, "type": "long" }, @@ -104213,215 +104208,204 @@ "type": "boolean" }, { - "description": "The minimum number of CPUs to be set with Custom Computer Offering", + "description": "Whether to cleanup instance and its associated resource from database upon expunge of the instance", "length": 255, - "name": "mincpunumber", + "name": "purgeresources", "required": false, - "since": "4.13", - "type": "integer" + "since": "4.20", + "type": "boolean" }, { - "description": "restrict the CPU usage to committed service offering", + "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": "limitcpuuse", + "name": "isvolatile", "required": false, "type": "boolean" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "the name of the service offering", "length": 255, - "name": "provisioningtype", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "The maximum memory size of the custom service offering in MB", + "description": "the total memory of the service offering in MB", "length": 255, - "name": "maxmemory", + "name": "memory", "required": false, - "since": "4.13", "type": "integer" }, { - "description": "length (in seconds) of the burst", + "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": "iopsreadratemaxlength", + "name": "cpuspeed", "required": false, - "type": "long" + "type": "integer" }, { - "description": "the total memory of the service offering in MB", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", "length": 255, - "name": "memory", + "name": "dynamicscalingenabled", "required": false, - "type": "integer" + "since": "4.16", + "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", + "description": "the host tag for this service offering.", "length": 255, - "name": "byteswriteratemax", + "name": "hosttags", "required": false, - "type": "long" + "type": "string" }, { - "description": "the CPU number of the service offering", + "description": "is this a system vm offering", "length": 255, - "name": "cpunumber", + "name": "issystem", "required": false, - "type": "integer" + "type": "boolean" }, { - "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.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "cpuspeed", + "name": "bytesreadratemaxlength", "required": false, - "type": "integer" + "type": "long" }, { - "description": "min iops of the compute offering", + "description": "max iops of the compute offering", "length": 255, - "name": "miniops", + "name": "maxiops", "required": false, "since": "4.4", "type": "long" }, { - "description": "Whether to cleanup instance and its associated resource from database upon expunge of the instance", + "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": "purgeresources", + "name": "deploymentplanner", "required": false, - "since": "4.20", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the disk offering to which service offering should be mapped", + "description": "min iops of the compute offering", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "miniops", "required": false, - "since": "4.17", - "type": "uuid" + "since": "4.4", + "type": "long" }, { - "description": "the tags for this service offering.", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "tags", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "type": "string" + "type": "list" }, { - "description": "bytes write rate of the disk offering", + "description": "VMs using this offering require root volume encryption", "length": 255, - "name": "byteswriterate", + "name": "encryptroot", "required": false, - "type": "long" + "since": "4.18", + "type": "boolean" }, { - "description": "Whether service offering size is custom or not", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "customized", + "name": "iopsreadrate", "required": false, - "since": "4.13", - "type": "boolean" + "type": "long" }, { - "description": "the host tag for this service offering.", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "hosttags", + "name": "bytesreadrate", "required": false, - "type": "string" + "type": "long" }, { - "description": "the Root disk size in GB.", + "description": "details for planner, used to store specific parameters", "length": 255, - "name": "rootdisksize", + "name": "serviceofferingdetails", "required": false, - "since": "4.15", - "type": "long" + "type": "map" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "length (in seconds) of the burst", "length": 255, - "name": "cachemode", + "name": "byteswriteratemaxlength", "required": false, - "since": "4.14", - "type": "string" + "type": "long" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "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": "dynamicscalingenabled", + "name": "diskofferingstrictness", "required": false, - "since": "4.16", + "since": "4.17", "type": "boolean" }, { - "description": "the HA for the service offering", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "offerha", + "name": "storagepolicy", + "related": "", "required": false, - "type": "boolean" + "since": "4.15", + "type": "uuid" }, { - "description": "The minimum memory size of the custom service offering in MB", + "description": "The maximum memory size of the custom service offering in MB", "length": 255, - "name": "minmemory", + "name": "maxmemory", "required": false, "since": "4.13", "type": "integer" }, { - "description": "io requests read rate of the disk offering", + "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "iopsreadrate", + "name": "systemvmtype", "required": false, - "type": "long" + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "iopswriteratemax", + "name": "byteswriterate", "required": false, "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", - "length": 255, - "name": "diskofferingstrictness", - "required": false, - "since": "4.17", - "type": "boolean" - }, - { - "description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "deploymentplanner", + "name": "iopswriteratemax", "required": false, - "type": "string" + "type": "long" }, { - "description": "VMs using this offering require root volume encryption", + "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", "length": 255, - "name": "encryptroot", + "name": "networkrate", "required": false, - "since": "4.18", - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "The maximum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "maxcpunumber", "required": false, "since": "4.13", - "type": "list" + "type": "integer" }, { - "description": "the name of the service offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "iopswriteratemaxlength", + "required": false, + "type": "long" }, { "description": "burst requests read rate of the disk offering", @@ -104431,65 +104415,58 @@ "type": "long" }, { - "description": "is this a system vm offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "issystem", + "name": "iopswriterate", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "The maximum number of CPUs to be set with Custom Computer Offering", + "description": "The minimum memory size of the custom service offering in MB", "length": 255, - "name": "maxcpunumber", + "name": "minmemory", "required": false, "since": "4.13", "type": "integer" }, { - "description": "bytes read rate of the disk offering", + "description": "the Root disk size in GB.", "length": 255, - "name": "bytesreadrate", + "name": "rootdisksize", "required": false, + "since": "4.15", "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "The minimum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "iopswriteratemaxlength", + "name": "mincpunumber", "required": false, - "type": "long" + "since": "4.13", + "type": "integer" }, { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", + "description": "the tags for this service offering.", "length": 255, - "name": "systemvmtype", + "name": "tags", "required": false, "type": "string" }, { - "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 containing domain(s), null for public offerings", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "zoneid", + "related": "listZones", "required": false, + "since": "4.13", "type": "list" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "length (in seconds) of the burst", "length": 255, - "name": "storagepolicy", - "related": "", + "name": "iopsreadratemaxlength", "required": false, - "since": "4.15", - "type": "uuid" + "type": "long" }, { "description": "burst bytes read rate of the disk offering", @@ -104499,11 +104476,26 @@ "type": "long" }, { - "description": "io requests write rate of the disk offering", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "iopswriterate", + "name": "provisioningtype", "required": false, - "type": "long" + "type": "string" + }, + { + "description": "the HA for the service offering", + "length": 255, + "name": "offerha", + "required": false, + "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 storage type of the service offering. Values are local and shared.", @@ -104511,110 +104503,117 @@ "name": "storagetype", "required": false, "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", + "type": "string" } ], "related": "updateServiceOffering,listServiceOfferings", "response": [ { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the service offering", + "name": "state", "type": "string" }, { - "description": "the name of the service offering", - "name": "name", - "type": "string" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "is this a system vm offering", - "name": "issystem", + "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": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the tags for the service offering", + "name": "storagetags", + "type": "string" }, - {}, { "description": "io requests write rate of the service offering", "name": "diskIopsWriteRate", "type": "long" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "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 service offering", + "name": "name", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "state of the service offering", - "name": "state", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the id of the service offering", + "name": "id", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "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": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "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 zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { "description": "is this a the systemvm type for system vm offering", @@ -104622,69 +104621,84 @@ "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" + }, + { + "description": "the ha support in the service offering", + "name": "offerha", + "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", "type": "boolean" }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "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 host tag for the service offering", - "name": "hosttags", + "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": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the tags for the service offering", - "name": "storagetags", - "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 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": "the max iops of the disk offering", - "name": "maxiops", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, - {}, { - "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 memory in MB", - "name": "memory", - "type": "integer" + "description": "Root disk size in GB", + "name": "rootdisksize", + "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 ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" }, { @@ -104693,84 +104707,80 @@ "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "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 id of the service offering", - "name": "id", - "type": "string" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "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": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, + {}, { - "description": "the number of CPU", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", + "description": "is this a system vm offering", + "name": "issystem", "type": "boolean" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "the storage type for this service offering", - "name": "storagetype", - "type": "string" + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, { "description": "additional key/value details tied with this service offering", @@ -104778,19 +104788,9 @@ "type": "map" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", - "type": "string" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" - }, - { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", - "type": "boolean" } ] }, @@ -104800,20 +104800,12 @@ "name": "assignVirtualMachine", "params": [ { - "description": "id of the VM to be moved", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "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.", + "description": "domain id of the new VM owner.", "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "type": "list" + "type": "uuid" }, { "description": "an optional project for the new VM owner.", @@ -104824,21 +104816,29 @@ "type": "uuid" }, { - "description": "domain id of the new VM owner.", + "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": "domainid", - "related": "listDomains,listDomains", + "name": "securitygroupids", + "related": "", "required": false, - "type": "uuid" + "type": "list" }, { - "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": "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": "securitygroupids", - "related": "", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "type": "list" }, + { + "description": "id of the VM to be moved", + "length": 255, + "name": "virtualmachineid", + "related": "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": "account name of the new VM owner.", "length": 255, @@ -104847,419 +104847,26 @@ "type": "string" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "related": "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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "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 domain name of the affinity group", - "name": "domain", - "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": "the account owning the affinity group", - "name": "account", - "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": "the domain ID of the affinity group", - "name": "domainid", - "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": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - {}, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "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 list of resource tags associated", - "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 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": "path of the Domain associated with the tag", - "name": "domainpath", - "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 project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - {}, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "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": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "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": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the ID of the backup offering of the virtual machine", "name": "backupofferingid", "type": "string" }, - { - "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 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 egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "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": "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" - }, - { - "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 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "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": "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the protocol of the security group rule", "name": "protocol", @@ -105269,91 +104876,59 @@ "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" - } - ], - "type": "set" - }, - { - "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 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": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "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" }, { - "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -105365,51 +104940,51 @@ "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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" + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "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 id of the group", - "name": "projectid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -105422,58 +104997,63 @@ "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": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, { "description": "the description of the security group", "name": "description", @@ -105484,88 +105064,216 @@ "name": "domainpath", "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 virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "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 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 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": "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": "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" + } + ], + "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": "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", "type": "string" } ], "type": "set" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "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": "the id of userdata used for the VM", + "name": "userdataid", "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 type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "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": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "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 service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "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": "the group ID of the virtual machine", - "name": "groupid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { @@ -105574,143 +105282,237 @@ "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": "NICs of the VNF appliance", - "name": "vnfnics", - "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 state of the virtual machine", - "name": "state", + "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": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "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", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "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": "Base64 string containing the user data", - "name": "userdata", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "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": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, { "description": "Vm details in key/value pairs.", "name": "details", "type": "map" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "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 ID of the affinity group", + "name": "domainid", + "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" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "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": "set" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the 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", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { @@ -105719,67 +105521,138 @@ "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + {}, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "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 memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, { "description": "the project id of the vm", "name": "projectid", "type": "string" }, { - "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": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "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 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": "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" }, { @@ -105788,8 +105661,23 @@ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "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": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -105803,43 +105691,38 @@ "type": "boolean" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "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", + "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -105848,96 +105731,213 @@ "type": "list" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "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", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "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": "publicipid", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "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 pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the account associated with the tag", + "name": "account", "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "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 date when this virtual machine was updated last time", "name": "lastupdated", "type": "date" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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" } ], @@ -105949,10 +105949,24 @@ "name": "listVmsForImport", "params": [ { - "description": "hypervisor type of the host", + "description": "List by keyword", "length": 255, - "name": "hypervisor", - "required": true, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the password for the host", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { @@ -105963,10 +105977,10 @@ "type": "string" }, { - "description": "List by keyword", + "description": "hypervisor type of the host", "length": 255, - "name": "keyword", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { @@ -105978,11 +105992,11 @@ "type": "uuid" }, { - "description": "", + "description": "the host name or IP address", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "host", + "required": true, + "type": "string" }, { "description": "", @@ -105990,118 +106004,82 @@ "name": "page", "required": false, "type": "integer" + } + ], + "related": "listVmwareDcVms,listUnmanagedInstances", + "response": [ + { + "description": "the operating system ID of the virtual machine", + "name": "osid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the host name or IP address", - "length": 255, - "name": "host", - "required": true, - "type": "string" + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" }, { - "description": "the password for the host", - "length": 255, - "name": "password", - "required": false, + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" - } - ], - "related": "listVmwareDcVms,listUnmanagedInstances", - "response": [ + }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", + "description": "the list of nics associated with the virtual machine", + "name": "nic", "response": [ { - "description": "the ID of the disk", - "name": "id", - "type": "string" - }, - { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorepath", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - }, - { - "description": "the position of the disk", - "name": "position", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the label of the disk", - "name": "label", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, - { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", - "type": "string" - }, - { - "description": "the power state of the virtual machine", - "name": "powerstate", - "type": "string" - }, - { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ { "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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -106110,9 +106088,9 @@ "type": "string" }, { - "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": "MTU configured on the NIC", @@ -106120,8 +106098,8 @@ "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -106130,64 +106108,54 @@ "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the nic", + "name": "id", "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": "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 cidr of IPv6 network", @@ -106195,115 +106163,147 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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", + "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 vm to which the nic belongs", - "name": "virtualmachineid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" } ], "type": "set" }, + {}, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" - }, - { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "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": "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", + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "type": "string" }, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", - "type": "string" + "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", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "the operating system of the virtual machine", + "name": "osdisplayname", "type": "string" }, { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "the label of the disk", + "name": "label", + "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 unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + } + ], + "type": "set" }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - } + {} ], "since": "4.19.0" }, @@ -106313,11 +106313,11 @@ "name": "configureNetscalerLoadBalancer", "params": [ { - "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", + "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": "lbdevicecapacity", + "name": "inline", "required": false, - "type": "long" + "type": "boolean" }, { "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", @@ -106326,6 +106326,13 @@ "required": false, "type": "boolean" }, + { + "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", + "length": 255, + "name": "lbdevicecapacity", + "required": false, + "type": "long" + }, { "description": "Netscaler load balancer device ID", "length": 255, @@ -106341,13 +106348,6 @@ "related": "createManagementNetworkIpRange", "required": false, "type": "list" - }, - { - "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" } ], "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", @@ -106358,51 +106358,45 @@ "type": "boolean" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "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": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, - {}, - {}, - { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, { - "description": "device state", - "name": "lbdevicestate", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" }, { - "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": "the private interface of the load balancer", - "name": "privateinterface", + "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": "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": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -106410,25 +106404,21 @@ "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "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", @@ -106438,6 +106428,16 @@ "description": "name of the provider", "name": "provider", "type": "string" + }, + { + "description": "device name", + "name": "lbdevicename", + "type": "string" + }, + { + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" } ] }, @@ -106446,13 +106446,6 @@ "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, @@ -106460,30 +106453,37 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric service group", + "length": 255, + "name": "servicegroupuuid", + "required": true, + "type": "string" } ], "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": "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" } ] }, @@ -106493,10 +106493,17 @@ "name": "addObjectStoragePool", "params": [ { - "description": "the URL for the object store", - "length": 2048, - "name": "url", - "required": true, + "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 tags for the storage pool", + "length": 255, + "name": "tags", + "required": false, "type": "string" }, { @@ -106507,58 +106514,51 @@ "type": "string" }, { - "description": "the object store provider name", - "length": 255, - "name": "provider", + "description": "the URL for the object store", + "length": 2048, + "name": "url", "required": true, "type": "string" }, { - "description": "the tags for the storage pool", + "description": "the object store provider name", "length": 255, - "name": "tags", - "required": false, + "name": "provider", + "required": true, "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" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the object store", + "name": "name", + "type": "string" }, - {}, { - "description": "the url of the object store", - "name": "url", - "type": "string" + "description": "the object store currently used size", + "name": "storageused", + "type": "long" }, { - "description": "the provider name of the object store", - "name": "providername", + "description": "the url of the object store", + "name": "url", "type": "string" }, + {}, { - "description": "the ID of the object store", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the object store", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the object store currently used size", - "name": "storageused", + "description": "the total size of the object store", + "name": "storagetotal", "type": "long" }, { @@ -106566,17 +106566,17 @@ "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "the total size of the object store", - "name": "storagetotal", - "type": "long" + "description": "the ID of the object store", + "name": "id", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the provider name of the object store", + "name": "providername", "type": "string" - } + }, + {} ], "since": "4.19.0" }, @@ -106586,23 +106586,24 @@ "name": "deleteUserFromProject", "params": [ { - "description": "ID of the project to remove the user from", + "description": "Id of the user to be removed from the project", "length": 255, - "name": "projectid", - "related": "", + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", "required": true, "type": "uuid" }, { - "description": "Id of the user to be removed from the project", + "description": "ID of the project to remove the user from", "length": 255, - "name": "userid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "projectid", + "related": "", "required": true, "type": "uuid" } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -106613,17 +106614,16 @@ "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", - "type": "string" } ], "since": "4.15.0" @@ -106643,17 +106643,12 @@ } ], "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", @@ -106664,6 +106659,11 @@ "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" @@ -106674,11 +106674,11 @@ "name": "listNetworkDevice", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "parameters for network device", @@ -106688,36 +106688,35 @@ "type": "map" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "description": "List by keyword", "length": 255, - "name": "networkdevicetype", + "name": "keyword", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, - "name": "page", + "name": "networkdevicetype", "required": false, - "type": "integer" + "type": "string" } ], "related": "addNetworkDevice", "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", @@ -106727,7 +106726,8 @@ "description": "the ID of the network device", "name": "id", "type": "string" - } + }, + {} ] }, { @@ -106736,11 +106736,12 @@ "name": "listProjectRoles", "params": [ { - "description": "List by keyword", + "description": "List project role by project ID.", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "projectid", + "related": "", + "required": true, + "type": "uuid" }, { "description": "", @@ -106749,6 +106750,13 @@ "required": false, "type": "integer" }, + { + "description": "List project role by project role name.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -106757,20 +106765,12 @@ "type": "integer" }, { - "description": "List project role by project role name.", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, - { - "description": "List project role by project ID.", - "length": 255, - "name": "projectid", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "List project role by project role ID.", "length": 255, @@ -106787,31 +106787,31 @@ "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 name of the role", "name": "name", "type": "string" }, + {}, { "description": "the ID of the role", "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", "name": "projectid", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { @@ -106838,11 +106838,22 @@ ], "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 url of the controller api", "name": "url", "type": "string" }, + {}, { "description": "device id of the controller", "name": "id", @@ -106853,28 +106864,17 @@ "name": "physicalnetworkid", "type": "string" }, - {}, - { - "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the name assigned to the controller", "name": "name", "type": "string" - } + }, + {} ] }, { @@ -106883,11 +106883,26 @@ "name": "updateTemplate", "params": [ { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "the ID of the image file", "length": 255, - "name": "details", + "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": "sort key of the template, integer", + "length": 255, + "name": "sortkey", "required": false, - "type": "map" + "type": "integer" + }, + { + "description": "the name of the image file", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { "description": "true if the template supports the sshkey upload feature; default is false", @@ -106897,43 +106912,34 @@ "type": "boolean" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "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": "ostypeid", - "related": "addGuestOs", + "name": "cleanupdetails", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "description": "true if the template type is routing i.e., if template is used to deploy router", + "length": 255, + "name": "isrouting", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "templatetype", + "name": "requireshvm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the tag for this template.", + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "templatetag", + "name": "arch", "required": false, - "since": "4.20.0", + "since": "4.20", "type": "string" }, - { - "description": "the ID of the image file", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" - }, { "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, @@ -106942,11 +106948,19 @@ "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "the ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "isrouting", + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the format for the image", @@ -106956,371 +106970,362 @@ "type": "string" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "passwordenabled", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "the tag for this template.", "length": 255, - "name": "arch", + "name": "templatetag", "required": false, - "since": "4.20", + "since": "4.20.0", "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": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "cleanupdetails", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "sort key of the template, integer", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "sortkey", + "name": "details", "required": false, - "type": "integer" + "type": "map" }, { - "description": "the name of the image file", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "name", + "name": "templatetype", "required": false, "type": "string" - }, - { - "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" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the type of the template", - "name": "templatetype", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the template name", + "name": "name", + "type": "string" }, { - "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "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 userdata linked to this template", - "name": "userdataname", + "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": "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 secondary storage host for the template", - "name": "hostid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "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": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "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": "resource type", + "name": "resourcetype", "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": "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": "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": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, - {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "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": "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": "the template name", - "name": "name", + "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": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "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 date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the status of the template", - "name": "status", - "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 for this template", - "name": "zonename", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "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": "true if this template is a public template, false otherwise", - "name": "ispublic", + "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": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the project name of the template", + "name": "project", + "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": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "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 name to which the template belongs", - "name": "account", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" + "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", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "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": "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 OS type for this template.", - "name": "ostypename", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "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 format of the template.", + "name": "format", + "type": "imageformat" }, { "description": "the account id to which the template belongs", @@ -107328,23 +107333,18 @@ "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", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" } ] @@ -107354,29 +107354,6 @@ "isasync": false, "name": "createVlanIpRange", "params": [ - { - "description": "the network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the Zone ID of the VLAN IP range", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "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": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, @@ -107386,18 +107363,19 @@ "type": "uuid" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "ip6gateway", + "name": "startipv6", "required": false, "type": "string" }, { - "description": "true if VLAN is of Virtual type, false if Direct", + "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", "length": 255, - "name": "forvirtualnetwork", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the physical network id", @@ -107414,6 +107392,14 @@ "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": "the ending IP address in the VLAN IP range", "length": 255, @@ -107421,6 +107407,14 @@ "required": false, "type": "string" }, + { + "description": "the network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + }, { "description": "the gateway of the VLAN IP range", "length": 255, @@ -107428,6 +107422,13 @@ "required": false, "type": "string" }, + { + "description": "the beginning IP address in the VLAN IP range", + "length": 255, + "name": "startip", + "required": false, + "type": "string" + }, { "description": "the ending IPv6 address in the IPv6 network range", "length": 255, @@ -107436,100 +107437,94 @@ "type": "string" }, { - "description": "the netmask of the VLAN IP range", + "description": "true if VLAN is of Virtual type, false if Direct", "length": 255, - "name": "netmask", + "name": "forvirtualnetwork", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "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": "ip6cidr", + "name": "vlan", "required": false, "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "startip", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "true if the IP range is used for NSX resource", + "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", "length": 255, - "name": "fornsx", + "name": "ip6gateway", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "string" }, { - "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", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "vlan", + "name": "netmask", "required": false, "type": "string" }, { - "description": "domain ID of the account owning a VLAN", + "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", + "description": "true if the IP range is used for NSX resource", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "fornsx", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "boolean" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "startipv6", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "updateVlanIpRange", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 ID or VID of the VLAN.", - "name": "vlan", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the cidr of the VLAN IP range", + "name": "cidr", + "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { @@ -107538,13 +107533,8 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { @@ -107552,65 +107542,66 @@ "name": "domainpath", "type": "string" }, + {}, { - "description": "the project name of the vlan range", - "name": "project", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "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", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, - {}, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "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": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", + "type": "boolean" }, + {}, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { @@ -107619,25 +107610,34 @@ "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, - {}, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the ID of the VLAN IP range", + "name": "id", + "type": "string" + }, + { + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -107655,47 +107655,58 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the vpn 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" }, { - "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 vpn to the end user or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" } ], "related": "", "response": [ { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "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 project name", + "name": "project", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, + {}, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "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", "type": "string" }, { @@ -107704,13 +107715,23 @@ "type": "boolean" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" + }, + { + "description": "State of vpn connection", + "name": "state", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { @@ -107718,34 +107739,19 @@ "name": "esplifetime", "type": "long" }, - { - "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": "the domain id of the owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name", - "name": "project", - "type": "string" - }, - { - "description": "State of vpn connection", - "name": "passive", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { @@ -107753,55 +107759,45 @@ "name": "ikelifetime", "type": "long" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, - {}, { "description": "the public IP address", "name": "publicip", "type": "string" }, { - "description": "the connection ID", - "name": "id", - "type": "string" - }, - { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" - }, - { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project id", - "name": "projectid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -107809,12 +107805,16 @@ "name": "domain", "type": "string" }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, { "description": "the owner", "name": "account", "type": "string" - }, - {} + } ], "since": "4.4" }, @@ -107823,13 +107823,6 @@ "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, @@ -107838,6 +107831,13 @@ "required": true, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -107856,23 +107856,49 @@ "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, + {}, { - "description": "the type of the network", - "name": "type", + "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 id of the network", - "name": "id", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" + }, + { + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "the name of the network", + "name": "name", "type": "string" }, { @@ -107880,8 +107906,8 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -107890,43 +107916,43 @@ "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -107937,187 +107963,29 @@ ], "type": "list" }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "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": "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 routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, { "description": "the domain name of the network owner", "name": "domain", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "the owner of the network", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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 private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "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": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { "description": "the list of services", "name": "service", "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 service provider name", "name": "provider", "response": [ - { - "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", @@ -108129,8 +107997,8 @@ "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { @@ -108142,6 +108010,38 @@ "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" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "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" } ], "type": "list" @@ -108155,18 +108055,18 @@ "type": "list" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { @@ -108175,54 +108075,104 @@ "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, + {}, { - "description": "The external id of the network", - "name": "externalid", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, - {}, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "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": "the date this network was created", + "name": "created", + "type": "date" + }, { "description": "The routes for the network to ease adding route in upstream router", "name": "ip6routes", "type": "set" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "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" }, { @@ -108231,89 +108181,119 @@ "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the type of the network", + "name": "type", "type": "string" }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, { "description": "The IPv4 routing type of network", "name": "ip4routing", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { "description": "true if the entity/resource has annotations", @@ -108321,9 +108301,14 @@ "type": "boolean" }, { - "description": "the name of the network", - "name": "name", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "Tungsten-Fabric virtual router the network belongs to", @@ -108331,58 +108316,73 @@ "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "list networks that are persistent", + "name": "ispersistent", + "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 associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the owner of the network", + "name": "account", "type": "string" } ] @@ -108402,6 +108402,12 @@ ], "related": "", "response": [ + {}, + { + "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", @@ -108412,12 +108418,6 @@ "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" } ] }, @@ -108427,12 +108427,11 @@ "name": "listManagementServers", "params": [ { - "description": "the id of the management server", + "description": "the name of the management server", "length": 255, - "name": "id", - "related": "listManagementServers", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -108449,16 +108448,17 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the id of the management server", "length": 255, - "name": "keyword", + "name": "id", + "related": "listManagementServers", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the management server", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" } @@ -108466,23 +108466,24 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the state of the management server", + "name": "state", + "type": "state" }, { - "description": "the ID of the management server", - "name": "id", - "type": "string" + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", "type": "string" }, { @@ -108491,19 +108492,19 @@ "type": "string" }, { - "description": "the version of the management server", - "name": "version", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", "type": "date" }, { - "description": "the IP Address for this Management Server", - "name": "serviceip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the last time this Management Server was started", @@ -108511,31 +108512,30 @@ "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the version of the management server", + "name": "version", + "type": "string" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "the ID of the management server", + "name": "id", "type": "string" }, - {}, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "the IP Address for this Management Server", + "name": "serviceip", "type": "string" }, + {}, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" }, - {}, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "the version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" } ] }, @@ -108545,19 +108545,27 @@ "name": "listTungstenFabricPolicyRule", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "keyword", - "required": false, + "name": "policyuuid", + "required": true, "type": "string" }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, { "description": "the uuid of Tungsten-Fabric rule", "length": 255, @@ -108573,63 +108581,60 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" - }, - { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "addTungstenFabricPolicyRule", "response": [ + { + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", + "type": "string" + }, { "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 destination end port", + "name": "destendport", + "type": "int" }, + {}, { - "description": "Tungsten-Fabric policy action", - "name": "action", + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "direction", + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", - "type": "string" + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" }, { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -108637,19 +108642,15 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", - "type": "string" + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" }, { "description": "Tungsten-Fabric policy uuid", @@ -108657,14 +108658,14 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", - "type": "string" + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", - "type": "int" + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", + "type": "string" }, { "description": "Tungsten-Fabric policy source end port", @@ -108672,21 +108673,20 @@ "type": "int" }, { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", + "description": "Tungsten-Fabric policy name", + "name": "direction", "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", "type": "int" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" - }, - {} + } ] }, { @@ -108694,13 +108694,6 @@ "isasync": true, "name": "deleteTungstenFabricPolicy", "params": [ - { - "description": "the Uuid of Tungsten-Fabric tag type", - "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -108708,30 +108701,37 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "the Uuid of Tungsten-Fabric tag type", + "length": 255, + "name": "policyuuid", + "required": true, + "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 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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -108758,21 +108758,15 @@ ], "related": "", "response": [ - {}, - { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", - "type": "string" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, { "description": "the project ID of the instance group", @@ -108780,46 +108774,52 @@ "type": "string" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, { - "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 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 project name of the instance group", - "name": "project", + "description": "the domain name of the instance group", + "name": "domain", "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 ID of the instance group", - "name": "id", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, - {} + {}, + { + "description": "the domain ID of the instance group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", + "type": "string" + } ] }, { @@ -108827,6 +108827,13 @@ "isasync": false, "name": "listTemplateDirectDownloadCertificates", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "list direct download certificate by ID", "length": 255, @@ -108836,11 +108843,12 @@ "type": "uuid" }, { - "description": "if set to true: include the hosts where the certificate is uploaded to", + "description": "the zone where certificates are uploaded", "length": 255, - "name": "listhosts", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -108850,61 +108858,51 @@ "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the zone where certificates are uploaded", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "if set to true: include the hosts where the certificate is uploaded to", "length": 255, - "name": "pagesize", + "name": "listhosts", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "", "response": [ { - "description": "the direct download certificate serial num", - "name": "serialnum", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "the direct download certificate id", + "name": "id", "type": "string" }, - {}, { - "description": "the direct download certificate version", - "name": "version", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, { "description": "the direct download certificate issuer", @@ -108912,10 +108910,17 @@ "type": "string" }, { - "description": "the direct download certificate id", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the direct download certificate version", + "name": "version", "type": "string" }, + {}, + {}, { "description": "the zone name where the certificate is uploaded", "name": "zonename", @@ -108927,13 +108932,8 @@ "type": "string" }, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" - }, - { - "description": "the direct download certificate issuer", - "name": "issuer", + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, { @@ -108950,11 +108950,19 @@ "name": "listUcsManagers", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "the zone id", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { "description": "the ID of the ucs manager", @@ -108967,31 +108975,23 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the zone id", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "the ID of the ucs manager", - "name": "id", + "description": "the name of ucs manager", + "name": "name", "type": "string" }, { @@ -109000,16 +109000,6 @@ "type": "string" }, {}, - { - "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", @@ -109020,6 +109010,16 @@ "name": "zoneid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the ucs manager", + "name": "id", + "type": "string" + }, {} ] }, @@ -109048,43 +109048,43 @@ "related": "listRouters,listInternalLoadBalancerVMs", "response": [ { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { @@ -109093,48 +109093,13 @@ "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "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 name of VPC the router belongs to", - "name": "vpcname", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { @@ -109143,69 +109108,43 @@ "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the first DNS for the router", + "name": "dns1", "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": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the name of the router", + "name": "name", "type": "string" }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { @@ -109213,14 +109152,15 @@ "name": "templateid", "type": "string" }, + {}, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { @@ -109228,23 +109168,18 @@ "name": "nic", "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the traffic type of the nic", + "name": "traffictype", "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": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -109253,13 +109188,18 @@ "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "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" }, { @@ -109268,19 +109208,19 @@ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { "description": "the netmask of the nic", @@ -109288,9 +109228,9 @@ "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 cidr of IPv6 network", @@ -109298,48 +109238,48 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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", + "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", + "description": "the ID of the corresponding network", + "name": "networkid", "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": "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the nic", - "name": "id", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -109348,83 +109288,154 @@ "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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", + "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": "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": "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", + "description": "the ID of the nic", + "name": "id", "type": "string" } ], "type": "set" }, + { + "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 version of template", + "name": "version", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, { "description": "the Zone ID for the router", "name": "zoneid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, + {}, { "description": "Last executed health check result for the router", "name": "healthcheckresults", @@ -109434,6 +109445,11 @@ "name": "checkname", "type": "string" }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, { "description": "the type of the health check - basic or advanced", "name": "checktype", @@ -109444,11 +109460,6 @@ "name": "details", "type": "string" }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, { "description": "the date this VPC was created", "name": "lastupdated", @@ -109458,59 +109469,48 @@ "type": "list" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "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 host ID for the router", - "name": "hostid", + "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", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the Zone name for the router", - "name": "zonename", + "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 public IP address for the router", - "name": "publicip", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" } ] @@ -109521,11 +109521,12 @@ "name": "updateVolume", "params": [ { - "description": "an optional field, whether to the display the volume to the end user or not.", + "description": "new name of the volume", "length": 255, - "name": "displayvolume", + "name": "name", "required": false, - "type": "boolean" + "since": "4.16", + "type": "string" }, { "description": "The state of the volume", @@ -109536,19 +109537,19 @@ "type": "string" }, { - "description": "the ID of the disk volume", + "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": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "The path of the volume", + "description": "an optional field, whether to the display the volume to the end user or not.", "length": 255, - "name": "path", + "name": "displayvolume", "required": false, - "type": "string" + "type": "boolean" }, { "description": "The chain info of the volume", @@ -109559,19 +109560,10 @@ "type": "string" }, { - "description": "new name of the volume", - "length": 255, - "name": "name", - "required": false, - "since": "4.16", - "type": "string" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The path of the volume", "length": 255, - "name": "customid", + "name": "path", "required": false, - "since": "4.4", "type": "string" }, { @@ -109590,54 +109582,57 @@ "required": false, "since": "4.3", "type": "uuid" + }, + { + "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" } ], - "related": "importVolume,createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", "response": [ { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "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", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "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", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { "description": "name of the virtual machine", @@ -109645,74 +109640,69 @@ "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "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": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "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": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "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": "cluster id of the volume", - "name": "clusterid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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": "name of the availability zone", @@ -109720,109 +109710,85 @@ "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, + {}, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "shared or local storage", + "name": "storagetype", "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": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "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", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, - {}, { - "description": "min iops of the disk volume", - "name": "miniops", + "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", - "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 ID of the domain associated with the disk volume", "name": "domainid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, + {}, { "description": "details for the volume repair result, they may vary for different hypervisors", "name": "volumerepairresult", "type": "map" }, { - "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": "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": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { @@ -109831,13 +109797,13 @@ "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { @@ -109846,98 +109812,102 @@ "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "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": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "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 format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, - {}, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, + { + "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 list of resource tags associated", "name": "tags", "response": [ { - "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", "type": "string" }, { @@ -109946,8 +109916,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -109956,13 +109926,13 @@ "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": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -109970,11 +109940,6 @@ "name": "value", "type": "string" }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", @@ -109986,37 +109951,72 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, { "description": "name of the disk offering", "name": "diskofferingname", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "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" } ] }, @@ -110026,12 +110026,11 @@ "name": "listTrafficTypes", "params": [ { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "List by keyword", @@ -110041,16 +110040,17 @@ "type": "string" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -110058,12 +110058,22 @@ "related": "", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "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 destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -110075,14 +110085,9 @@ "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": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "state of the network provider", @@ -110090,14 +110095,9 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "uuid of the network provider", @@ -110112,14 +110112,6 @@ "isasync": false, "name": "updateAccount", "params": [ - { - "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, @@ -110128,18 +110120,12 @@ "type": "string" }, { - "description": "Current account name", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "New name for the account", + "description": "The UUID of the dynamic role to set for the account", "length": 255, - "name": "newname", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Details for the account used to store specific parameters", @@ -110156,6 +110142,13 @@ "required": false, "type": "uuid" }, + { + "description": "Current account name", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "The UUID of the domain where the account exists", "length": 255, @@ -110163,33 +110156,70 @@ "related": "listDomains,listDomains", "required": false, "type": "uuid" + }, + { + "description": "New name for the account", + "length": 255, + "name": "newname", + "required": false, + "type": "string" } ], "related": "disableAccount,enableAccount,listAccounts", "response": [ { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "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 networks the account can own", + "name": "networklimit", "type": "string" }, { @@ -110197,114 +110227,109 @@ "name": "user", "response": [ { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user ID", + "name": "id", "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 timezone user was created in", - "name": "timezone", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "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", + "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 name of the role", - "name": "rolename", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "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": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { "description": "true if user has two factor authentication is mandated", @@ -110312,158 +110337,193 @@ "type": "boolean" }, { - "description": "the user state", - "name": "state", + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "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", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, - {}, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, { "description": "the total number of templates available to be created by this account", "name": "templateavailable", "type": "string" }, - {}, { - "description": "the name of the account", - "name": "name", + "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) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, + {}, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, + {}, { "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": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", "type": "integer" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of 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", + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "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": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { @@ -110472,49 +110532,64 @@ "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "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 id of the account", - "name": "id", + "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 total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { "description": "the total number of projects available for administration by this account", @@ -110522,470 +110597,596 @@ "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the state of the account", + "name": "state", "type": "string" - }, + } + ] + }, + { + "description": "Adds secondary storage.", + "isasync": false, + "name": "addSecondaryStorage", + "params": [ { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the Zone ID for the secondary storage", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the URL for the secondary storage", + "length": 255, + "name": "url", + "required": true, + "type": "string" + } + ], + "related": "listSwifts", + "response": [ + { + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, + {}, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, + {}, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "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 (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, { - "description": "Adds secondary storage.", + "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": "addSecondaryStorage", + "name": "updateVirtualMachine", "params": [ { - "description": "the Zone ID for the secondary storage", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "displayvm", + "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": "user generated name", + "length": 255, + "name": "displayname", + "required": false, + "type": "string" + }, + { + "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": "the ID of the OS type that best represents this VM.", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", "required": false, "type": "uuid" }, { - "description": "the URL for the secondary storage", + "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", "length": 255, - "name": "url", + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "group of the virtual machine", + "length": 255, + "name": "group", + "required": false, + "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": "list of security group ids to be applied on the virtual machine.", + "length": 255, + "name": "securitygroupids", + "related": "", + "required": false, + "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", + "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)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "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": "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": "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": "instance name of the user vm", + "length": 255, + "name": "instancename", + "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": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "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": "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" } ], - "related": "listSwifts", + "related": "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": "the Zone name of the image store", - "name": "zonename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "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", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the protocol of the image store", - "name": "protocol", + "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": "the amount of the vm's CPU currently used", + "name": "cpuused", "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 name of the image store", - "name": "name", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, - {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "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": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "type": "uuid" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "list of security group ids to be applied on the virtual machine.", - "length": 255, - "name": "securitygroupids", - "related": "", - "required": false, - "type": "list" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "instance name of the user vm", - "length": 255, - "name": "instancename", - "required": false, - "since": "4.4", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "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, + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "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", + "description": "ssh key-pairs", + "name": "keypairs", "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 ID of the availability zone for the virtual machine", + "name": "zoneid", "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 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": "user generated name", - "length": 255, - "name": "displayname", - "required": false, + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "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", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the ID of the OS type that best represents this VM.", - "length": 255, - "name": "ostypeid", - "related": "addGuestOs", - "required": false, - "type": "uuid" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "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 ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "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": "the VM's primary IP address", + "name": "ipaddress", + "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "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, + "description": "the id of userdata used for the VM", "name": "userdataid", - "related": "", - "required": false, - "since": "4.18", - "type": "uuid" + "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, + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "Base64 string containing the user data", "name": "userdata", - "required": false, - "since": "4.16.0", "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": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "group of the virtual machine", - "length": 255, - "name": "group", - "required": false, + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if high-availability is enabled for the virtual machine, false otherwise", - "length": 255, - "name": "haenable", - "required": false, - "type": "boolean" + "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.", - "length": 255, - "name": "displayvm", - "required": false, - "type": "boolean" - } - ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "response": [ + "description": "the ID of the virtual machine", + "name": "id", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "tag key name", - "name": "key", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "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": "the type of the affinity group", + "name": "type", + "type": "string" } ], "type": "set" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "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", + "description": "the state of the virtual machine", + "name": "state", "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "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 name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "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": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { @@ -110993,143 +111194,138 @@ "name": "nic", "response": [ { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the name of the corresponding network", + "name": "networkname", "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": "true if nic is default, false otherwise", - "name": "macaddress", + "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 IPv6 address of network", - "name": "ip6address", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "name": "macaddress", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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" }, { - "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "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 ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -111138,127 +111334,66 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" } ], "type": "set" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "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": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "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": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "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 backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - {}, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, { "description": "Vm details in key/value pairs.", "name": "details", "type": "map" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "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": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { @@ -111271,71 +111406,133 @@ "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 egress rules associated with the security group", - "name": "egressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "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" + } + ], + "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 name of the security group", + "name": "name", + "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 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 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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -111344,13 +111541,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -111359,8 +111561,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -111368,93 +111570,73 @@ "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" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "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 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 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 id of the security group rule", + "name": "ruleid", + "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 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": "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", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -111463,28 +111645,28 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "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": "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" }, { @@ -111493,245 +111675,139 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 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 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 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 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": "resource type", - "name": "resourcetype", - "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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 group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - {}, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, { "description": "true if high-availability is enabled, false otherwise", "name": "haenable", "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "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", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, + {}, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, + {}, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { @@ -111740,216 +111816,140 @@ "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, - {}, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "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", + "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 availability zone for the virtual machine", - "name": "zonename", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "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 used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "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", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "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 vGPU type used by the virtual machine", - "name": "vgpu", + "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 host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the affinity group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "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": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", + "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 service offering of the virtual machine", - "name": "serviceofferingname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" } ] @@ -111959,20 +111959,6 @@ "isasync": true, "name": "disableAccount", "params": [ - { - "description": "Disables specified account.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "If true, only lock the account; else disable the account", - "length": 255, - "name": "lock", - "required": true, - "type": "boolean" - }, { "description": "Disables specified account in this domain.", "length": 255, @@ -111981,6 +111967,13 @@ "required": false, "type": "uuid" }, + { + "description": "Disables specified account.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "Account id", "length": 255, @@ -111988,53 +111981,55 @@ "related": "disableAccount,enableAccount,listAccounts", "required": false, "type": "uuid" + }, + { + "description": "If true, only lock the account; else disable the account", + "length": 255, + "name": "lock", + "required": true, + "type": "boolean" } ], "related": "enableAccount,listAccounts", "response": [ { - "description": "the id of the account", - "name": "id", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "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": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -112043,24 +112038,34 @@ "type": "integer" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { "description": "the total memory (in MB) the account can own", @@ -112068,13 +112073,14 @@ "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 name of the account", - "name": "name", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { @@ -112083,18 +112089,13 @@ "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { @@ -112102,14 +112103,15 @@ "name": "templatetotal", "type": "long" }, + {}, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { @@ -112117,133 +112119,113 @@ "name": "volumeavailable", "type": "string" }, - { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "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", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the api key of the user", + "name": "apikey", "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 user email address", - "name": "email", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, - { - "description": "the user lastname", - "name": "lastname", - "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", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -112252,114 +112234,117 @@ "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the type of the role", + "name": "roletype", "type": "string" } ], "type": "list" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, - {}, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, - {}, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "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", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { "description": "the total number of projects available for administration by this account", @@ -112367,14 +112352,19 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the total number of virtual machines available for this account to acquire", @@ -112382,34 +112372,34 @@ "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the state of the account", - "name": "state", - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", + "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" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { "description": "the total primary storage space (in GiB) owned by account", @@ -112417,14 +112407,24 @@ "type": "long" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" } ] }, @@ -112433,6 +112433,13 @@ "isasync": false, "name": "listDomains", "params": [ + { + "description": "flag to display the resource icon for domains", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, { "description": "List by keyword", "length": 255, @@ -112441,11 +112448,11 @@ "type": "string" }, { - "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", + "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": "details", + "name": "listall", "required": false, - "type": "list" + "type": "boolean" }, { "description": "Tag for resource type to return usage", @@ -112456,131 +112463,429 @@ "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 domain by domain name.", "length": 255, - "name": "listall", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List domains by domain level.", + "length": 255, + "name": "level", + "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": "list" + }, + { + "description": "List domain by domain ID.", + "length": 255, + "name": "id", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "listDomains", + "response": [ + { + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + {}, + { + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "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 domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the ID of the domain", + "name": "id", + "type": "string" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the name of the domain", + "name": "name", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the path of the domain", + "name": "path", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + {}, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the state of the domain", + "name": "state", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "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", + "type": "string" + } + ] + }, + { + "description": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", + "isasync": false, + "name": "resetUserDataForVirtualMachine", + "params": [ + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "flag to display the resource icon for domains", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "showicon", + "name": "userdatadetails", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "", + "description": "the ID of the userdata", "length": 255, - "name": "pagesize", + "name": "userdataid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List domains by domain level.", + "description": "an optional project for the virtual machine", "length": 255, - "name": "level", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", + "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": "integer" + "type": "string" }, { - "description": "List domain by domain ID.", + "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "listDomains,listDomains", - "required": false, + "related": "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": "List domain by domain name.", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "name", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "listDomains", + "related": "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 total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" - }, - { - "description": "the name of the domain", - "name": "name", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" - }, - { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "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 snapshots available for this domain", - "name": "snapshotavailable", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { @@ -112589,511 +112894,388 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" - }, - { - "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 total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "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 number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - {}, - { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "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": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, - {}, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the level of the domain", - "name": "level", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "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 domain", - "name": "state", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, - { - "description": "the ID of the domain", - "name": "id", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "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": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", - "isasync": false, - "name": "resetUserDataForVirtualMachine", - "params": [ - { - "description": "the ID of the userdata", - "length": 255, - "name": "userdataid", - "related": "", - "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "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, + "description": "Base64 string containing the user data", "name": "userdata", - "required": false, "type": "string" }, { - "description": "an optional project for the virtual machine", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the VM's primary IP address", + "name": "ipaddress", "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 ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "response": [ - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "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": "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": "tag key name", - "name": "key", - "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the netmask of the nic", + "name": "netmask", "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 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 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 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 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": "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 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": "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" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "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 project id of the group", - "name": "projectid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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 IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "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": "macaddress", + "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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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": "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "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": "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 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": "the ID of the domain associated with the tag", - "name": "domainid", + "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": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -113107,24 +113289,19 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" } ], "type": "set" @@ -113134,24 +113311,14 @@ "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -113159,252 +113326,261 @@ "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", + "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" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "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": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "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", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "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 IPv6 address of network", - "name": "ip6address", - "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 gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "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": "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", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project id of the group", + "name": "projectid", "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", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the domain ID of the security group", + "name": "domainid", "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": "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": "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": "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the project name of the group", + "name": "project", "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 traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "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": "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": "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" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "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": "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "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" }, { @@ -113412,120 +113588,91 @@ "name": "networkkbsread", "type": "long" }, + {}, { - "description": "Base64 string containing the user data", - "name": "userdata", - "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 template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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 write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, + {}, { "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", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, - {}, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -113533,18 +113680,18 @@ "name": "affinitygroup", "response": [ { - "description": "the type of the affinity group", - "name": "type", + "description": "the ID of the affinity group", + "name": "id", "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 name of the affinity group", - "name": "name", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -113563,9 +113710,9 @@ "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": "the account owning the affinity group", @@ -113573,231 +113720,75 @@ "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "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 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 name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - {}, { "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "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 project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "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 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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -113811,8 +113802,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -113821,107 +113812,116 @@ "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 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": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, - {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "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 group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" } ], @@ -113932,14 +113932,6 @@ "isasync": true, "name": "deleteTemplate", "params": [ - { - "description": "the ID of the template", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" - }, { "description": "Necessary if the template's type is system.", "length": 255, @@ -113948,6 +113940,14 @@ "since": "4.20.0", "type": "boolean" }, + { + "description": "the ID of zone of the template", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, { "description": "Force delete a template.", "length": 255, @@ -113957,11 +113957,11 @@ "type": "boolean" }, { - "description": "the ID of zone of the template", + "description": "the ID of the template", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, + "name": "id", + "related": "listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, "type": "uuid" } ], @@ -113971,6 +113971,11 @@ "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", @@ -113982,12 +113987,7 @@ "name": "displaytext", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -113996,49 +113996,43 @@ "name": "listNetworkACLLists", "params": [ { - "description": "list network ACLs by VPC ID", + "description": "Lists network ACL with the specified ID.", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", "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": "", + "description": "list network ACLs by network ID", "length": 255, - "name": "pagesize", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "projectid", - "related": "", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Lists network ACL with the specified ID.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { "description": "List by keyword", @@ -114048,26 +114042,27 @@ "type": "string" }, { - "description": "list network ACLs by specified name", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "name", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "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": "list network ACLs by VPC ID", "length": 255, - "name": "listall", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -114077,20 +114072,25 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list network ACLs by network ID", + "description": "list network ACLs by specified name", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "name", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createNetworkACLList", @@ -114100,29 +114100,25 @@ "name": "name", "type": "string" }, - { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "Description of the ACL", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ACL", + "name": "id", "type": "string" }, { - "description": "the ID of the ACL", - "name": "id", + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", "type": "string" }, {}, @@ -114131,10 +114127,14 @@ "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "Description of the ACL", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", "type": "string" } ] @@ -114156,23 +114156,24 @@ "related": "copySnapshot,listSnapshots", "response": [ { - "description": "the status of the template", - "name": "status", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "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": "name of the disk volume", - "name": "volumename", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { @@ -114180,34 +114181,99 @@ "name": "hasannotations", "type": "boolean" }, + { + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "state of the disk volume", "name": "volumestate", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "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": "name of the disk volume", + "name": "volumename", + "type": "string" + }, { "description": "name of the datastore for the snapshot entry", "name": "datastorename", "type": "string" }, + { + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "ID of the snapshot", + "name": "id", + "type": "string" + }, + { + "description": "name of the snapshot", + "name": "name", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -114216,23 +114282,23 @@ "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": "tag value", + "name": "value", "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": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -114241,62 +114307,41 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "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": "display name of the os on volume", "name": "osdisplayname", "type": "string" }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" - }, - { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" - }, { "description": "download progress of a snapshot", "name": "downloaddetails", "type": "map" }, - {}, - { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" - }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { @@ -114305,44 +114350,19 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" - }, - { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" - }, - { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { "description": "the domain name of the snapshot's account", @@ -114350,39 +114370,19 @@ "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "name of the snapshot", - "name": "name", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "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" } ] }, @@ -114391,14 +114391,6 @@ "isasync": true, "name": "updateVpnGateway", "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", - "type": "boolean" - }, { "description": "id of customer gateway", "length": 255, @@ -114407,6 +114399,14 @@ "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, @@ -114418,78 +114418,78 @@ ], "related": "", "response": [ - {}, - { - "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 removed", - "name": "removed", - "type": "date" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, { "description": "is vpn gateway for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the project id", + "name": "projectid", "type": "string" }, + {}, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the vpc id of this gateway", + "name": "vpcid", + "type": "string" + }, + { + "description": "the owner", + "name": "account", "type": "string" }, + {}, { "description": "the project name", "name": "project", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, - {} + { + "description": "the vpc name of this gateway", + "name": "vpcname", + "type": "string" + } ], "since": "4.4" }, @@ -114508,23 +114508,23 @@ } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "the 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", @@ -114538,20 +114538,18 @@ "name": "deleteSecurityGroup", "params": [ { - "description": "the project of the security group", + "description": "The ID of the security group. Mutually exclusive with id parameter", "length": 255, - "name": "projectid", - "related": "", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The ID of the security group. Mutually exclusive with name parameter", + "description": "the account of the security group. Must be specified with domain ID", "length": 255, - "name": "id", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the domain ID of account owning the security group", @@ -114562,41 +114560,43 @@ "type": "uuid" }, { - "description": "the account of the security group. Must be specified with domain ID", + "description": "the project of the security group", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The ID of the security group. Mutually exclusive with id parameter", + "description": "The ID of the security group. Mutually exclusive with name parameter", "length": 255, - "name": "name", + "name": "id", + "related": "", "required": false, - "type": "string" + "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": "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" } ] @@ -114607,19 +114607,20 @@ "name": "importVolume", "params": [ { - "description": "the ID of the storage pool", + "description": "the ID of the disk offering linked to the volume", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, + "name": "diskofferingid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "an optional account for the volume. Must be used with domainId.", + "description": "import volume for the project", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the name of the volume. If not set, it will be set to the path of the volume.", @@ -114629,163 +114630,225 @@ "type": "string" }, { - "description": "import volume to the domain specified", + "description": "an optional account for the volume. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the path of the volume", + "description": "the ID of the storage pool", "length": 255, - "name": "path", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "import volume for the project", + "description": "import volume to the domain specified", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the ID of the disk offering linked to the volume", + "description": "the path of the volume", "length": 255, - "name": "diskofferingid", - "related": "", - "required": false, - "type": "uuid" + "name": "path", + "required": true, + "type": "string" } ], "related": "createVolume,listVolumes,recoverVolume,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", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", - "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", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "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", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, + {}, { - "description": "the path of the volume", - "name": "path", + "description": "the chain info of the volume", + "name": "chaininfo", "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 associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the list of resource tags associated", + "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 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 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" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, { - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "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": "the project name of the vpn", - "name": "project", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "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 status of the volume", + "name": "status", "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": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - {}, { - "description": "ID of the disk volume", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { @@ -114794,48 +114857,43 @@ "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { @@ -114844,236 +114902,178 @@ "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "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": "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" - } - ], - "type": "set" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "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": "the project id of the vpn", - "name": "projectid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "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", + "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": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "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": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the path of the volume", + "name": "path", "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", + "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "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": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, - {}, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { @@ -115082,9 +115082,9 @@ "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" } ], "since": "4.19.1" @@ -115095,19 +115095,19 @@ "name": "createTemplate", "params": [ { - "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", + "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": "snapshotid", - "related": "copySnapshot,listSnapshots", + "name": "volumeid", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, { - "description": "the tag for this template.", + "description": "true if the template requires HVM, false otherwise", "length": 255, - "name": "templatetag", + "name": "requireshvm", "required": false, - "type": "string" + "type": "boolean" }, { "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", @@ -115117,43 +115117,19 @@ "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if this template is a public template, false otherwise", "length": 255, - "name": "isdynamicallyscalable", + "name": "ispublic", "required": false, "type": "boolean" }, { - "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": "an optional accountName. Must be used with domainId.", + "description": "the name of the template", "length": 255, - "name": "account", - "required": false, - "since": "4.19.0", + "name": "name", + "required": true, "type": "string" }, - { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" - }, - { - "description": "true if the template supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" - }, { "description": "the ID of the OS Type that best represents the OS of this template.", "length": 255, @@ -115163,11 +115139,13 @@ "type": "uuid" }, { - "description": "the name of the template", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "domainid", + "related": "listDomains", + "required": false, + "since": "4.19.0", + "type": "uuid" }, { "description": "true if this template is a featured template, false otherwise", @@ -115177,41 +115155,39 @@ "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "sshkeyenabled", "required": false, - "since": "4.19.0", - "type": "uuid" + "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "ispublic", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "create template for the project", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "since": "4.19.0", + "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 ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", "length": 255, - "name": "volumeid", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "snapshotid", + "related": "copySnapshot,listSnapshots", "required": false, "type": "uuid" }, { - "description": "true if the template requires HVM, false otherwise", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "requireshvm", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, @@ -115219,10 +115195,26 @@ "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": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "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": "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 tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "type": "string" + }, { "description": "32 or 64 bit", "length": 255, @@ -115231,11 +115223,12 @@ "type": "integer" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "create template for the project", "length": 255, - "name": "details", + "name": "projectid", + "related": "", "required": false, - "type": "map" + "type": "uuid" }, { "description": "The display text of the template, defaults to the 'name'.", @@ -115243,49 +115236,62 @@ "name": "displaytext", "required": false, "type": "string" + }, + { + "description": "true if the template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "listIsos,registerTemplate,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 the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the template ID", - "name": "id", + "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 date this template was created", - "name": "created", - "type": "date" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { "description": "additional key/value details tied with template", @@ -115293,9 +115299,14 @@ "type": "map" }, { - "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 project id of the template", + "name": "projectid", + "type": "string" }, { "description": "the account name to which the template belongs", @@ -115303,33 +115314,95 @@ "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "customer associated with the tag", + "name": "customer", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "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 status of the template", - "name": "status", + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { @@ -115338,254 +115411,243 @@ "type": "boolean" }, { - "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": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "checksum of the template", + "name": "checksum", + "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" }, { - "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", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "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 name of the OS type for this template.", "name": "ostypename", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the URL which the template/iso is registered from", "name": "url", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "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", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of the zone for this template", + "name": "zonename", "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 date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the template name", + "name": "name", + "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 the zone for this template", - "name": "zonename", + "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 id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, + {}, { "description": "path of the Domain the template belongs to", "name": "domainpath", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "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": "id of the resource", - "name": "resourceid", - "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 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" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the template 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 processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, - {}, { "description": "the project name of the template", "name": "project", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "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": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" - }, - {}, + } + ] + }, + { + "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": "the account id to which the template belongs", - "name": "accountid", + "description": "DNS domain suffix that the certificate is granted for.", + "length": 255, + "name": "domainsuffix", + "required": true, "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "The private key for the attached certificate.", + "length": 65535, + "name": "privatekey", + "required": false, "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "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" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The certificate to be uploaded.", + "length": 65535, + "name": "certificate", + "required": true, "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "A name / alias for the certificate.", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the ID of the zone for this template", - "name": "zoneid", - "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", + "description": "message of the certificate upload operation", + "name": "message", "type": "string" }, { - "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" - } + }, + {} ] }, { @@ -115594,20 +115656,13 @@ "name": "listDedicatedClusters", "params": [ { - "description": "the ID of the domain associated with the cluster", + "description": "list dedicated clusters by affinity group", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "affinitygroupid", + "related": "", "required": false, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the ID of the cluster", "length": 255, @@ -115617,9 +115672,9 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "the name of the account associated with the cluster. Must be used with domainId.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, @@ -115631,48 +115686,41 @@ "type": "integer" }, { - "description": "the name of the account associated with the cluster. Must be used with domainId.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list dedicated clusters by affinity group", + "description": "", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the domain associated with the cluster", + "length": 255, + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" } ], "related": "", "response": [ - { - "description": "the ID of the cluster", - "name": "clusterid", - "type": "string" - }, - { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", - "type": "string" - }, + {}, { "description": "the ID of the dedicated resource", "name": "id", "type": "string" }, - { - "description": "the name of the cluster", - "name": "clustername", - "type": "string" - }, {}, { - "description": "the domain ID of the cluster", - "name": "domainid", - "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 cluster", @@ -115680,78 +115728,30 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the cluster", + "name": "clustername", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "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 domain ID of the cluster", + "name": "domainid", "type": "string" }, { - "description": "The private key for the attached certificate.", - "length": 65535, - "name": "privatekey", - "required": false, + "description": "the ID of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "The certificate to be uploaded.", - "length": 65535, - "name": "certificate", - "required": true, + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "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" - }, - { - "description": "DNS domain suffix that the certificate is granted for.", - "length": 255, - "name": "domainsuffix", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "message of the certificate upload operation", - "name": "message", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {} + } ] }, { @@ -115761,6 +115761,13 @@ "params": [], "related": "", "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "timestamp when the run got over", "name": "updated_on", @@ -115770,13 +115777,6 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.7.0" @@ -115787,19 +115787,18 @@ "name": "listTungstenFabricNetwork", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "networkuuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "", "length": 255, - "name": "networkuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -115823,47 +115822,48 @@ "type": "string" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric network uuid", - "name": "uuid", + "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": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, {}, + {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "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 network name", "name": "name", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -115880,49 +115880,42 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "addTrafficMonitor", "response": [ { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" - }, - { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "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 external firewall", - "name": "zoneid", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { @@ -115931,15 +115924,22 @@ "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {}, + { + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" + }, + {} ] }, { @@ -115959,14 +115959,8 @@ "related": "", "response": [ { - "description": "the project id of the bgp peer", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "id of the bgp peer", - "name": "id", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { @@ -115975,13 +115969,13 @@ "type": "string" }, { - "description": "password of bgp peer", - "name": "password", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { @@ -115990,55 +115984,61 @@ "type": "date" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", - "type": "string" + "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", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "password of bgp peer", + "name": "password", "type": "string" }, + {}, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, + {}, { "description": "additional key/value details of the bgp peer", "name": "details", "type": "map" }, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" + }, + { + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" } ], "since": "4.20.0" @@ -116049,20 +116049,20 @@ "name": "updatePortForwardingRule", "params": [ { - "description": "the private end port of the port forwarding rule", + "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, - "name": "privateendport", + "name": "virtualmachineid", + "related": "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": "integer" + "type": "uuid" }, { - "description": "the ID of the port forwarding rule", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "id", - "related": "updatePortForwardingRule", - "required": true, + "name": "fordisplay", + "required": false, "since": "4.4", - "type": "uuid" + "type": "boolean" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -116073,28 +116073,28 @@ "type": "string" }, { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "VM guest nic Secondary ip address for the port forwarding rule", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "vmguestip", "required": false, - "type": "uuid" + "since": "4.5", + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the private end port of the port forwarding rule", "length": 255, - "name": "fordisplay", + "name": "privateendport", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "VM guest nic Secondary ip address for the port forwarding rule", + "description": "the ID of the port forwarding rule", "length": 255, - "name": "vmguestip", - "required": false, - "since": "4.5", - "type": "string" + "name": "id", + "related": "updatePortForwardingRule", + "required": true, + "since": "4.4", + "type": "uuid" }, { "description": "the private start port of the port forwarding rule", @@ -116107,44 +116107,33 @@ "related": "", "response": [ { - "description": "is firewall 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 public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "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 ending port of port forwarding rule's private port range", - "name": "publicendport", + "name": "privateendport", "type": "string" }, { - "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 ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { @@ -116152,35 +116141,40 @@ "name": "virtualmachinedisplayname", "type": "string" }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "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 guest network the port forwarding rule belongs to", - "name": "networkid", + "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", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "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", + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { @@ -116188,8 +116182,13 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -116198,8 +116197,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -116208,13 +116207,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -116223,42 +116222,43 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "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": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "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", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -116267,6 +116267,13 @@ "isasync": true, "name": "associateIpAddress", "params": [ + { + "description": "the account to associate with this IP address", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", "length": 255, @@ -116290,6 +116297,14 @@ "required": false, "type": "uuid" }, + { + "description": "the ID of the domain to associate with this IP address", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, { "description": "region ID from where portable IP is to be associated.", "length": 255, @@ -116314,33 +116329,18 @@ "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 ID of the domain to associate with this IP address", + "description": "The network this IP address should be associated to.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, { - "description": "the account to associate with this IP address", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "The network this IP address should be associated to.", + "description": "the ID of the availability zone you want to acquire an public IP address from", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" } @@ -116348,74 +116348,84 @@ "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "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": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", "type": "boolean" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", "type": "boolean" }, + {}, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "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": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, - {}, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "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", + "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" }, { @@ -116423,89 +116433,103 @@ "name": "allocated", "type": "date" }, - {}, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "public IP address id", - "name": "id", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "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 the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "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": "tag value", - "name": "value", + "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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "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 ID of the domain associated with the tag", - "name": "domainid", + "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": "customer associated with the tag", - "name": "customer", + "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" }, { @@ -116514,91 +116538,67 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", - "type": "string" - }, - { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" - }, - { - "description": "public IP address", - "name": "ipaddress", - "type": "string" + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "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": "true if range is dedicated for System VMs", - "name": "forsystemvms", + "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 VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, + {}, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" } ] @@ -116625,22 +116625,22 @@ ], "related": "", "response": [ + {}, { - "description": "SolidFire Volume Access Group Ids", - "name": "solidFireVolumeAccessGroupIds", - "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": "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[]" } ] }, @@ -116659,23 +116659,23 @@ } ], "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": "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", @@ -116691,41 +116691,41 @@ "related": "listAlerts", "response": [ { - "description": "description of the alert", - "name": "description", - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the name of the alert", "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 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" + }, + { + "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" } ] }, @@ -116734,6 +116734,27 @@ "isasync": true, "name": "createNetworkACL", "params": [ + { + "description": "scl entry action, allow or deny", + "length": 255, + "name": "action", + "required": false, + "type": "string" + }, + { + "description": "the ending port of ACL", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "A description indicating why the ACL rule is required.", + "length": 255, + "name": "reason", + "required": false, + "type": "string" + }, { "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, @@ -116750,25 +116771,25 @@ "type": "uuid" }, { - "description": "the ending port of ACL", + "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "endport", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "error code for this ICMP message", + "description": "type of the ICMP message being sent", "length": 255, - "name": "icmpcode", + "name": "icmptype", "required": false, "type": "integer" }, { - "description": "scl entry action, allow or deny", + "description": "the starting port of ACL", "length": 255, - "name": "action", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -116778,20 +116799,6 @@ "since": "4.4", "type": "boolean" }, - { - "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": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - }, { "description": "The network of the VM the ACL will be created for", "length": 255, @@ -116801,71 +116808,48 @@ "type": "uuid" }, { - "description": "The number of the ACL item, its ordering", + "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "number", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the starting port of ACL", + "description": "The number of the ACL item, its ordering", "length": 255, - "name": "startport", + "name": "number", "required": false, "type": "integer" }, { - "description": "A description indicating why the ACL rule is required.", - "length": 255, - "name": "reason", - "required": false, - "type": "string" - }, - { - "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", + "description": "error code for this ICMP message", "length": 255, - "name": "traffictype", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" } ], "related": "updateNetworkACLItem,moveNetworkAclItem", "response": [ { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "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 name of the ACL this item belongs to", @@ -116877,18 +116861,14 @@ "name": "action", "type": "string" }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, + {}, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -116896,88 +116876,108 @@ "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", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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": "the project id the tag belongs to", - "name": "projectid", + "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 account associated with the tag", + "name": "account", + "type": "string" } ], "type": "list" }, { - "description": "Number of the ACL Item", - "name": "number", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "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": "the ID of the ACL Item", + "name": "id", + "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": "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", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" } ] @@ -116988,19 +116988,26 @@ "name": "resetSSHKeyForVirtualMachine", "params": [ { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "names of the ssh key pairs to be used to login to the virtual machine", "length": 255, - "name": "account", + "name": "keypairs", + "required": false, + "since": "4.17", + "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": "names of the ssh key pairs to be used to login to the virtual machine", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, - "name": "keypairs", + "name": "account", "required": false, - "since": "4.17", - "type": "list" + "type": "string" }, { "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", @@ -117010,14 +117017,6 @@ "required": false, "type": "uuid" }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" - }, { "description": "an optional project for the ssh key", "length": 255, @@ -117027,565 +117026,402 @@ "type": "uuid" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "The ID of the virtual machine", "length": 255, - "name": "keypair", - "required": false, - "type": "string" + "name": "id", + "related": "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" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "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 the service offering of the virtual machine", - "name": "serviceofferingid", - "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": "publicip", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "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": "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 type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "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", + "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 user's name who deployed the virtual machine", - "name": "username", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the project id of the vm", + "name": "projectid", "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 write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "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": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "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", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, + {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the 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": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "the project name where tag belongs to", - "name": "project", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" } ], "type": "set" }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "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": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "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": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "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 userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "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": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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" + "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 ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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 id associated with this nic via Static nat rule", + "name": "publicipid", + "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 netmask of the nic", - "name": "netmask", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "name": "isdefault", + "type": "boolean" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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", + "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", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -117594,155 +117430,114 @@ "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the traffic type of the nic", + "name": "traffictype", "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 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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "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 type of the nic", + "name": "type", "type": "string" } ], "type": "set" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "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": "publicipid", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain ID of the affinity group", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the project name of the affinity group", + "description": "the project name where tag belongs to", "name": "project", "type": "string" } @@ -117750,116 +117545,124 @@ "type": "set" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "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 account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, {}, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, { "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 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 project id the tag belongs to", - "name": "projectid", - "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": "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": "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": "the project name where tag belongs to", - "name": "project", - "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": "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 description of the security group", - "name": "description", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the project name of the group", @@ -117870,23 +117673,43 @@ "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": "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -117900,8 +117723,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -117910,38 +117733,28 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 protocol of the security group rule", "name": "protocol", @@ -117966,16 +117779,6 @@ "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" } ], "type": "set" @@ -117986,8 +117789,8 @@ "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -117995,42 +117798,37 @@ "name": "ingressrule", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "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 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": "id of the resource", - "name": "resourceid", + "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" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -118044,88 +117842,290 @@ "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": "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 name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "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" } ], "type": "set" }, - { - "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 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": "security group name", + "name": "securitygroupname", + "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "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 name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "account owning the security group rule", + "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": "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 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": "resource type", + "name": "resourcetype", + "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 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 account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" } ], "type": "set" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "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 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": "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "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": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" } ] }, @@ -118141,14 +118141,6 @@ "required": true, "type": "string" }, - { - "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, @@ -118162,13 +118154,20 @@ "name": "startip", "required": true, "type": "string" + }, + { + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "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" }, { @@ -118176,9 +118175,10 @@ "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" }, { @@ -118196,11 +118196,11 @@ "name": "addKubernetesSupportedVersion", "params": [ { - "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": "the minimum number of CPUs to be set with the Kubernetes version", "length": 255, - "name": "checksum", - "required": false, - "type": "string" + "name": "mincpunumber", + "required": true, + "type": "integer" }, { "description": "the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64", @@ -118211,25 +118211,33 @@ "type": "string" }, { - "description": "the minimum number of CPUs to be set with the Kubernetes version", + "description": "the URL of the binaries ISO for Kubernetes supported version", "length": 255, - "name": "mincpunumber", + "name": "url", + "required": false, + "type": "string" + }, + { + "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "length": 255, + "name": "minmemory", "required": true, "type": "integer" }, { - "description": "the name of the Kubernetes supported version", + "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": "name", + "name": "checksum", "required": false, "type": "string" }, { - "description": "the URL of the binaries ISO for Kubernetes supported version", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "url", + "name": "zoneid", + "related": "listZones", "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", @@ -118247,42 +118255,33 @@ "type": "string" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "the name of the Kubernetes supported version", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": false, - "type": "uuid" - }, - { - "description": "the minimum RAM size in MB to be set with the Kubernetes version", - "length": 255, - "name": "minmemory", - "required": true, - "type": "integer" + "type": "string" } ], "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, - {}, { - "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": "Kubernetes semantic version", - "name": "semanticversion", - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "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" }, { @@ -118296,40 +118295,29 @@ "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "Kubernetes semantic version", + "name": "semanticversion", "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", + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", "type": "boolean" }, - { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", - "type": "string" - }, - { - "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": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" }, { "description": "the name of the binaries ISO for Kubernetes supported version", @@ -118337,8 +118325,8 @@ "type": "string" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { @@ -118346,10 +118334,22 @@ "name": "supportsautoscaling", "type": "boolean" }, + {}, + { + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" + }, { "description": "the id of the zone in which Kubernetes supported version is available", "name": "zoneid", "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" } ] }, @@ -118362,7 +118362,7 @@ "description": "the ID of the template for the virtual machine", "length": 255, "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" }, @@ -118370,7 +118370,7 @@ "description": "the ID of the ISO for the virtual machine", "length": 255, "name": "isoid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" }, @@ -118390,113 +118390,141 @@ "type": "string" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the account name to which the template belongs", + "name": "account", "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": "additional key/value details tied with template", - "name": "details", - "type": "map" + "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": "path of the Domain the template belongs to", "name": "domainpath", "type": "string" }, - {}, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, { "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", "name": "directdownload", "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "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", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the template name", - "name": "name", + "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", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, - {}, { "description": "the type of the template", "name": "templatetype", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { @@ -118505,8 +118533,18 @@ "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "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 template display text", + "name": "displaytext", "type": "string" }, { @@ -118514,34 +118552,50 @@ "name": "templatetag", "type": "string" }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "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": "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 featured template, false otherwise", - "name": "isfeatured", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { @@ -118550,27 +118604,27 @@ "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "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", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -118584,18 +118638,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -118604,61 +118658,31 @@ "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "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 secondary storage host for the template", "name": "hostid", "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 date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "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" }, { @@ -118667,48 +118691,19 @@ "type": "imageformat" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "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: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, + {}, { - "description": "the status of the template", - "name": "status", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { @@ -118717,19 +118712,24 @@ "type": "set" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" } ], "since": "4.18.0" @@ -118739,14 +118739,6 @@ "isasync": false, "name": "listGlobalLoadBalancerRules", "params": [ - { - "description": "region ID", - "length": 255, - "name": "regionid", - "related": "", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -118755,26 +118747,26 @@ "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -118784,25 +118776,26 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "region ID", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "regionid", + "related": "", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "account", + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the global load balancer rule", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, @@ -118814,62 +118807,22 @@ "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.", + "description": "", "length": 255, - "name": "listall", + "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" } ], "related": "updateGlobalLoadBalancerRule", "response": [ - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "global load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the description of the global load balancer rule", - "name": "description", - "type": "string" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "name of the global load balancer rule", - "name": "name", - "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 load balancer", "name": "projectid", @@ -118880,88 +118833,58 @@ "name": "loadbalancerrule", "response": [ { - "description": "the public ip address id", - "name": "publicipid", - "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 name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the name of the zone the load balancer rule belongs to", "name": "zonename", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "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 id of the zone the rule belongs to", - "name": "zoneid", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { @@ -118969,13 +118892,18 @@ "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -118984,8 +118912,13 @@ "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", "type": "string" }, { @@ -118994,8 +118927,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -119008,50 +118941,85 @@ "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 value", - "name": "value", - "type": "string" } ], "type": "list" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "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", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the state of the rule", + "name": "state", "type": "string" } ], "type": "list" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "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", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { @@ -119060,54 +119028,79 @@ "type": "string" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" + }, + { + "description": "the description of the global load balancer rule", + "name": "description", + "type": "string" + }, + { + "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", + "description": "name of the global load balancer rule", + "name": "name", "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": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", + "type": "string" } ] }, { - "description": "Release the dedication for cluster", - "isasync": true, - "name": "releaseDedicatedCluster", + "description": "Updates a disk offering.", + "isasync": false, + "name": "deleteDiskOffering", "params": [ { - "description": "the ID of the Cluster", + "description": "ID of the disk offering", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "id", + "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": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -119117,46 +119110,53 @@ "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": "Updates a disk offering.", - "isasync": false, - "name": "deleteDiskOffering", + "description": "Release the dedication for cluster", + "isasync": true, + "name": "releaseDedicatedCluster", "params": [ { - "description": "ID of the disk offering", + "description": "the ID of the Cluster", "length": 255, - "name": "id", - "related": "", + "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": "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" - }, - {} + } ] }, { @@ -119181,11 +119181,6 @@ "name": "id", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Name of the container cluster", "name": "name", @@ -119196,12 +119191,17 @@ "name": "configdata", "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" - } + }, + {} ] }, { @@ -119219,6 +119219,12 @@ } ], "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", @@ -119229,18 +119235,12 @@ "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" - } + {} ] }, { @@ -119259,26 +119259,26 @@ ], "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": "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.9.0" @@ -119298,17 +119298,12 @@ } ], "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", @@ -119319,6 +119314,11 @@ "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" } ] }, @@ -119328,20 +119328,20 @@ "name": "listInternalLoadBalancerVMs", "params": [ { - "description": "the Pod ID of the Internal LB VM", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the Zone ID of the Internal LB VM", + "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "fetchhealthcheckresults", "required": false, - "type": "uuid" + "since": "4.14", + "type": "boolean" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -119351,25 +119351,27 @@ "type": "boolean" }, { - "description": "the state of the Internal LB VM", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "state", + "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.", + "description": "List Internal LB VMs by VPC", "length": 255, - "name": "listall", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the Pod ID of the Internal LB VM", "length": 255, - "name": "account", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the host ID of the Internal LB VM", @@ -119380,25 +119382,18 @@ "type": "uuid" }, { - "description": "the ID of the Internal LB VM", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the Internal LB VM", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "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" }, @@ -119410,11 +119405,17 @@ "type": "string" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", + "description": "if true is passed for this parameter, list only VPC Internal LB VMs", "length": 255, - "name": "fetchhealthcheckresults", + "name": "forvpc", + "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, - "since": "4.14", "type": "boolean" }, { @@ -119426,231 +119427,77 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "the Zone ID of the Internal LB VM", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List Internal LB VMs by VPC", + "description": "the state of the Internal LB VM", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "if true is passed for this parameter, list only VPC Internal LB VMs", + "description": "", "length": 255, - "name": "forvpc", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "listRouters", "response": [ { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "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 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 domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the account associated with the router", + "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 ipaddress", "name": "projectid", "type": "string" }, - {}, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { @@ -119658,38 +119505,38 @@ "name": "nic", "response": [ { - "description": "Type of adapter if available", - "name": "adaptertype", + "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": "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", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the type of the nic", + "name": "type", "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 id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -119698,48 +119545,63 @@ "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "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": "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 name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -119748,13 +119610,13 @@ "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -119763,57 +119625,174 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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", + "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", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "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", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "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 Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "the ID of the nic", - "name": "id", + "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 name of the corresponding network", - "name": "networkname", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" } ], - "type": "set" + "type": "list" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" }, { "description": "the host ID for the router", @@ -119821,8 +119800,8 @@ "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { @@ -119830,65 +119809,61 @@ "name": "isredundantrouter", "type": "boolean" }, - {}, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the name of the router", + "name": "name", "type": "string" }, + {}, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, + {}, { "description": "the link local IP address for the router", "name": "linklocalip", "type": "string" }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, { "description": "the ID of the corresponding public network", "name": "publicnetworkid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the template ID for the router", + "name": "templateid", "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 ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { @@ -119897,18 +119872,18 @@ "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -119917,19 +119892,44 @@ "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "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": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" } ] }, @@ -119939,24 +119939,25 @@ "name": "listCiscoVnmcResources", "params": [ { - "description": "Cisco VNMC resource ID", + "description": "the Physical Network ID", "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", + "name": "physicalnetworkid", + "related": "", "required": false, "type": "uuid" }, { - "description": "", + "description": "Cisco VNMC resource ID", "length": 255, - "name": "pagesize", + "name": "resourceid", + "related": "listCiscoVnmcResources", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -119968,12 +119969,11 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", @@ -119987,14 +119987,14 @@ {}, {}, {}, - {}, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {}, + {}, + {} ] }, { @@ -120002,13 +120002,6 @@ "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": "ID of cluster", "length": 255, @@ -120016,48 +120009,55 @@ "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": "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" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" + "description": "Id of the cluster", + "name": "clusterid", + "type": "string" + }, + {}, + { + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { "description": "Start event Id of the DRS Plan", "name": "eventid", "type": "string" }, - {}, { - "description": "Id of the cluster", - "name": "clusterid", - "type": "string" + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, + {}, + {}, { "description": "List of migrations", "name": "migrations", "type": "list" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "unique ID of the drs plan for cluster", "name": "id", @@ -120081,13 +120081,6 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -120098,10 +120091,17 @@ "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" @@ -120111,6 +120111,13 @@ "isasync": false, "name": "uploadResourceIcon", "params": [ + { + "description": "Base64 string representation of the resource icon/image", + "length": 2097152, + "name": "base64image", + "required": true, + "type": "string" + }, { "description": "list of resources to upload the icon/image for", "length": 255, @@ -120124,17 +120131,14 @@ "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -120146,16 +120150,12 @@ "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" }, @@ -120164,13 +120164,6 @@ "isasync": false, "name": "updateKubernetesSupportedVersion", "params": [ - { - "description": "the enabled or disabled state of the Kubernetes supported version", - "length": 255, - "name": "state", - "required": true, - "type": "string" - }, { "description": "the ID of the Kubernetes supported version", "length": 255, @@ -120178,96 +120171,103 @@ "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, "type": "uuid" + }, + { + "description": "the enabled or disabled state of the Kubernetes supported version", + "length": 255, + "name": "state", + "required": true, + "type": "string" } ], "related": "listKubernetesSupportedVersions", "response": [ { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, + { + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" + }, { "description": "the minimum number of CPUs needed for the Kubernetes supported version", "name": "mincpunumber", "type": "integer" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "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 Kubernetes supported version", "name": "name", "type": "string" }, + {}, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "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": "the id of the Kubernetes supported version", - "name": "id", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "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": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", + "type": "string" }, {}, + { + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" + }, { "description": "whether Kubernetes supported version supports HA, multi-control nodes", "name": "supportsha", "type": "boolean" }, - { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" - }, { "description": "the enabled or disabled state of the Kubernetes supported version", "name": "state", "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", - "type": "string" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", - "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" } ] }, @@ -120286,28 +120286,28 @@ } ], "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": "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.20.0" }, @@ -120335,14 +120335,19 @@ "related": "listGuestNetworkIpv6Prefixes", "response": [ { - "description": "guest IPv6 prefix", - "name": "prefix", + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", "type": "string" }, { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "guest IPv6 prefix", + "name": "prefix", + "type": "string" }, { "description": "count of the used IPv6 subnets for the prefix.", @@ -120350,36 +120355,31 @@ "type": "integer" }, { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", - "type": "integer" + "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" }, {}, + { + "description": "id of the guest IPv6 prefix", + "name": "id", + "type": "string" + }, { "description": "count of the total IPv6 subnets for the prefix.", "name": "totalsubnets", "type": "integer" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "id of the guest IPv6 prefix", - "name": "id", - "type": "string" + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" } ], "since": "4.17.0.0" @@ -120389,6 +120389,20 @@ "isasync": false, "name": "createRole", "params": [ + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "Creates a role with this unique name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, @@ -120404,76 +120418,62 @@ "required": false, "type": "uuid" }, - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, { "description": "The description of the role", "length": 255, "name": "description", "required": false, "type": "string" - }, - { - "description": "Creates a role with this unique name", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "related": "listRoles,updateRole", "response": [ { - "description": "the type of the role", - "name": "type", - "type": "string" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, + {}, { - "description": "the state of the role", - "name": "state", - "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 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", + "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": "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 type of the role", + "name": "type", + "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "the description of the role", + "name": "description", "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.9.0" @@ -120484,24 +120484,17 @@ "name": "getUploadParamsForVolume", "params": [ { - "description": "the name of the volume/template/iso", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, - "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": "an optional accountName. Must be used with domainId.", + "description": "Image store uuid", "length": 255, - "name": "account", + "name": "imagestoreuuid", "required": false, "type": "string" }, @@ -120513,11 +120506,20 @@ "type": "string" }, { - "description": "Image store uuid", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "imagestoreuuid", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" + }, + { + "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": "", + "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.", @@ -120527,69 +120529,67 @@ "type": "string" }, { - "description": "Upload volume/template/iso for the project", + "description": "the name of the volume/template/iso", "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" } ], "related": "getUploadParamsForTemplate,getUploadParamsForIso", "response": [ { - "description": "the timestamp after which the signature expires", - "name": "expires", - "type": "string" + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, {}, { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", + "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 template/volume ID", "name": "id", "type": "uuid" }, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "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" + } ], "since": "4.6.0" }, @@ -120599,27 +120599,20 @@ "name": "updateAutoScaleVmProfile", "params": [ { - "description": "the template of the auto deployed 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": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "the ID of the userdata", "length": 255, - "name": "userdatadetails", + "name": "userdataid", + "related": "", "required": false, "since": "4.18.1", - "type": "map" - }, - { - "description": "the ID of the autoscale vm profile", - "length": 255, - "name": "id", - "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, "type": "uuid" }, { @@ -120630,38 +120623,28 @@ "type": "map" }, { - "description": "the service offering of the auto deployed virtual machine", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "expungevmgraceperiod", "required": false, - "since": "4.18.0", - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the userdata", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "userdataid", - "related": "", + "name": "userdatadetails", "required": false, "since": "4.18.1", - "type": "uuid" + "type": "map" }, { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "the ID of the autoscale vm profile", "length": 255, - "name": "autoscaleuserid", - "related": "disableUser,getUser,listUsers,lockUser", - "required": false, + "name": "id", + "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, "type": "uuid" }, - { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "length": 255, - "name": "expungevmgraceperiod", - "required": false, - "type": "integer" - }, { "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, @@ -120679,12 +120662,29 @@ "type": "map" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the ID of the user used to launch and destroy the VMs", "length": 255, - "name": "customid", + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" + }, + { + "description": "the template of the auto deployed virtual machine", + "length": 255, + "name": "templateid", + "related": "listIsos,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", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.18.0", + "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", @@ -120698,43 +120698,28 @@ "related": "listAutoScaleVmProfiles", "response": [ { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" - }, - { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "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": "the autoscale vm profile ID", - "name": "id", + "description": "the name of userdata used for the VM", + "name": "userdataname", "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 time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, {}, @@ -120744,30 +120729,35 @@ "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "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", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, { - "description": "Base64 encoded VM user data", - "name": "userdata", + "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 vm profile belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, + {}, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { @@ -120775,35 +120765,45 @@ "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, + {}, { - "description": "path of the domain to which the vm profile belongs", - "name": "domainpath", + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" + }, + { + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" + }, + { + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" } ] @@ -120825,49 +120825,49 @@ "related": "", "response": [ { - "description": "the project name of the vm group", - "name": "project", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the autoscale vm group ", + "name": "name", + "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, - {}, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the public port", + "name": "publicport", "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 id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { @@ -120876,24 +120876,29 @@ "type": "string" }, { - "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 number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "the project name of the vm group", + "name": "project", + "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + { + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "is group 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": "true if the entity/resource has annotations", @@ -120901,48 +120906,49 @@ "type": "boolean" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" - }, - { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, + {}, { - "description": "the autoscale vm group ID", - "name": "id", + "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 guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "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 load balancer rule ID", - "name": "lbruleid", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the private port", - "name": "privateport", + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" + }, + { + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { @@ -120951,25 +120957,19 @@ "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": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the public ip address", + "name": "publicip", + "type": "string" }, - {}, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "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" } ] }, @@ -120979,34 +120979,34 @@ "name": "listGuestNetworkIpv6Prefixes", "params": [ { - "description": "UUID of the IPv6 prefix.", + "description": "", "length": 255, - "name": "id", - "related": "listGuestNetworkIpv6Prefixes", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "UUID of zone to which the IPv6 prefix belongs to.", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "UUID of zone to which the IPv6 prefix belongs to.", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "UUID of the IPv6 prefix.", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listGuestNetworkIpv6Prefixes", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -121024,29 +121024,25 @@ "type": "string" }, { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", - "type": "string" + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" }, {}, { - "description": "id of the guest IPv6 prefix", - "name": "id", - "type": "string" - }, - { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", + "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", + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", "type": "integer" }, { @@ -121055,15 +121051,19 @@ "type": "integer" }, { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" + "description": "id of the guest IPv6 prefix", + "name": "id", + "type": "string" }, - {}, { "description": " date when this IPv6 prefix was created.", "name": "created", "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.17.0" @@ -121073,13 +121073,6 @@ "isasync": true, "name": "updateGuestOsMapping", "params": [ - { - "description": "Hypervisor specific name for this Guest OS", - "length": 255, - "name": "osnameforhypervisor", - "required": true, - "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, @@ -121088,6 +121081,13 @@ "since": "4.19.0", "type": "boolean" }, + { + "description": "Hypervisor specific name for this Guest OS", + "length": 255, + "name": "osnameforhypervisor", + "required": true, + "type": "string" + }, { "description": "UUID of the Guest OS to hypervisor name Mapping", "length": 255, @@ -121100,26 +121100,26 @@ "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 ID of the Guest OS mapping", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "hypervisor specific name for the Guest OS", "name": "osnameforhypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" }, - {}, { "description": "standard display name for the Guest OS", "name": "osdisplayname", @@ -121127,23 +121127,23 @@ }, {}, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "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": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" } ], @@ -121155,22 +121155,33 @@ "name": "deleteTungstenFabricTag", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "taguuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "the ID of zone", "length": 255, - "name": "taguuid", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "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", @@ -121181,18 +121192,7 @@ "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" - } + {} ] }, { @@ -121200,6 +121200,22 @@ "isasync": false, "name": "updateHostPassword", "params": [ + { + "description": "the host ID", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, { "description": "the username for the host/cluster", "length": 255, @@ -121220,47 +121236,31 @@ "name": "update_passwd_on_host", "required": false, "type": "boolean" - }, - { - "description": "the host ID", - "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", - "required": false, - "type": "uuid" - }, - { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "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": "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" - } + {}, + {} ] }, { @@ -121275,6 +121275,13 @@ "required": true, "type": "string" }, + { + "description": "the beginning IP address in the portable IP range", + "length": 255, + "name": "startip", + "required": true, + "type": "string" + }, { "description": "the gateway for the portable IP range", "length": 255, @@ -121283,11 +121290,12 @@ "type": "string" }, { - "description": "the beginning IP address in the portable IP range", + "description": "Id of the Region", "length": 255, - "name": "startip", + "name": "regionid", + "related": "", "required": true, - "type": "string" + "type": "integer" }, { "description": "the ending IP address in the portable IP range", @@ -121297,199 +121305,416 @@ "type": "string" }, { - "description": "Id of the Region", + "description": "VLAN id, if not specified defaulted to untagged", "length": 255, + "name": "vlan", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" + }, + {}, + { + "description": "Region Id in which portable ip range is provisioned", "name": "regionid", + "type": "integer" + }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "the end ip of the portable IP range", + "name": "endip", + "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": "portable IP range ID", + "name": "id", + "type": "string" + }, + { + "description": "the start ip of the portable IP range", + "name": "startip", + "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 domain ID the portable IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "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": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "VPC the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "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" + } + ], + "type": "list" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "Deletes Webhook delivery", + "isasync": false, + "name": "deleteWebhookDelivery", + "params": [ + { + "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": "startdate", + "required": false, + "type": "date" + }, + { + "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": "enddate", + "required": false, + "type": "date" + }, + { + "description": "The ID of the Webhook delivery", + "length": 255, + "name": "id", "related": "", - "required": true, + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the management server", + "length": 255, + "name": "managementserverid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the Webhook", + "length": 255, + "name": "webhookid", + "related": "createWebhook", + "required": false, + "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" + } + ], + "since": "4.20.0" + }, + { + "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": "whether this cluster is managed by cloudstack", + "length": 255, + "name": "managedstate", + "required": false, + "type": "string" + }, + { + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" + }, + { + "description": "hypervisor type of the cluster", + "length": 255, + "name": "clustertype", + "required": false, + "type": "string" + }, + { + "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 cluster name", + "length": 255, + "name": "clustername", + "required": false, + "type": "string" + }, + { + "description": "hypervisor type of the cluster", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + } + ], + "related": "addCluster", + "response": [ + { + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "the cluster ID", + "name": "id", + "type": "string" }, { - "description": "VLAN id, if not specified defaulted to untagged", - "length": 255, - "name": "vlan", - "required": false, + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "the end ip of the portable IP range", - "name": "endip", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the Pod ID of the cluster", + "name": "podid", "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 cluster", + "name": "allocationstate", + "type": "string" }, { - "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", - "name": "portableipaddress", + "description": "the capacity of the Cluster", + "name": "capacity", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the Zone ID", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" } ], "type": "list" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the start ip of the portable IP range", - "name": "startip", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "portable IP range ID", - "name": "id", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, + {}, { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" - } - ], - "since": "4.2.0" - }, - { - "description": "Deletes Webhook delivery", - "isasync": false, - "name": "deleteWebhookDelivery", - "params": [ - { - "description": "The ID of the Webhook delivery", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" + "description": "the cluster name", + "name": "name", + "type": "string" }, { - "description": "The ID of the management server", - "length": 255, - "name": "managementserverid", - "related": "", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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 considered.", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" }, { - "description": "The ID of the Webhook", - "length": 255, - "name": "webhookid", - "related": "createWebhook", - "required": false, - "type": "uuid" + "description": "the Zone ID of the cluster", + "name": "zoneid", + "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 considered.", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "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.20.0" + } + ] }, { "description": "Lists the VMs in a VMware Datacenter", @@ -121497,110 +121722,105 @@ "name": "listVmwareDcVms", "params": [ { - "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", + "name": "vcenter", "required": false, "type": "string" }, { - "description": "The Username required to connect to resource.", + "description": "The password for specified username.", "length": 255, - "name": "username", + "name": "password", "required": false, "type": "string" }, { - "description": "Name of VMware datacenter.", + "description": "UUID of a linked existing vCenter", "length": 255, - "name": "datacentername", + "name": "existingvcenterid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "The Username required to connect to resource.", "length": 255, - "name": "pagesize", + "name": "username", "required": false, - "type": "integer" + "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": "List by keyword", "length": 255, - "name": "vcenter", + "name": "keyword", "required": false, "type": "string" }, { - "description": "UUID of a linked existing vCenter", + "description": "", "length": 255, - "name": "existingvcenterid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "The password for specified username.", + "description": "", "length": 255, - "name": "password", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "Name of VMware datacenter.", "length": 255, - "name": "page", + "name": "datacentername", "required": false, - "type": "integer" + "type": "string" } ], "related": "listUnmanagedInstances", "response": [ { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "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", + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", "type": "integer" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", - "type": "string" - }, - { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" }, + {}, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory of the virtual machine in MB", + "name": "memory", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, + {}, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" }, - {}, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "type": "string" }, { @@ -121608,53 +121828,63 @@ "name": "nic", "response": [ { - "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 ID of the corresponding network", + "name": "networkid", "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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the 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": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -121663,14 +121893,14 @@ "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": "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 ip address of the nic", @@ -121678,24 +121908,19 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the corresponding network", + "name": "networkname", "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": "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "the broadcast uri of the nic", @@ -121703,81 +121928,66 @@ "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", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "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 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" } ], "type": "set" }, { - "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 name of the host to which virtual machine belongs", - "name": "hostname", + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, { @@ -121789,46 +121999,16 @@ "name": "position", "type": "integer" }, - { - "description": "the controller of the disk", - "name": "datastorepath", - "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": "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 file path of the disk image", - "name": "imagepath", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" - }, { "description": "the label of the disk", "name": "label", @@ -121838,218 +122018,53 @@ "description": "the ID of the disk", "name": "id", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", - "type": "string" - } - ] - }, - { - "description": "Updates an existing cluster", - "isasync": false, - "name": "updateCluster", - "params": [ - { - "description": "whether this cluster is managed by cloudstack", - "length": 255, - "name": "managedstate", - "required": false, - "type": "string" - }, - { - "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 ID of the Cluster", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - }, - { - "description": "hypervisor type of the cluster", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" - }, - { - "description": "hypervisor type of the cluster", - "length": 255, - "name": "clustertype", - "required": false, - "type": "string" - }, - { - "description": "the cluster name", - "length": 255, - "name": "clustername", - "required": false, - "type": "string" - }, - { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - } - ], - "related": "addCluster", - "response": [ - { - "description": "the capacity of the Cluster", - "name": "capacity", - "response": [ - { - "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 Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", + "description": "the file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the controller of the disk", + "name": "datastorehost", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the controller of the disk", + "name": "controller", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the controller of the disk", + "name": "datastoretype", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" } ], - "type": "list" - }, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - {}, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" + "type": "set" }, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", - "type": "string" + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the cluster name", + "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - {}, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" - }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the operating system ID of the virtual machine", + "name": "osid", "type": "string" }, { @@ -122058,64 +122073,53 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", - "type": "string" - }, - { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" } ] }, { - "description": "List profile in ucs manager", + "description": "Lists storage providers.", "isasync": false, - "name": "listUcsProfiles", + "name": "listStorageProviders", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the id for the ucs manager", + "description": "List by keyword", "length": 255, - "name": "ucsmanagerid", - "related": "", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "the type of storage provider: either primary or image", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "type", + "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", @@ -122124,28 +122128,28 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the storage provider", + "name": "name", "type": "string" }, { - "description": "ucs profile dn", - "name": "ucsdn", + "description": "the type of the storage provider: primary or image provider", + "name": "type", "type": "string" } ] }, { - "description": "Lists storage providers.", + "description": "List profile in ucs manager", "isasync": false, - "name": "listStorageProviders", + "name": "listUcsProfiles", "params": [ { - "description": "the type of storage provider: either primary or image", + "description": "", "length": 255, - "name": "type", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "", @@ -122155,44 +122159,40 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the id for the ucs manager", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "ucsmanagerid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "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 type of the storage provider: primary or image provider", - "name": "type", - "type": "string" - }, - {}, - { - "description": "the name of the storage provider", - "name": "name", + "description": "ucs profile dn", + "name": "ucsdn", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -122216,22 +122216,22 @@ "name": "jobid", "type": "string" }, - {}, - {}, { "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 secret key of the registered user", "name": "secretkey", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.10.0" @@ -122241,14 +122241,6 @@ "isasync": true, "name": "updateGlobalLoadBalancerRule", "params": [ - { - "description": "the ID of the global load balancer rule", - "length": 255, - "name": "id", - "related": "updateGlobalLoadBalancerRule", - "required": true, - "type": "uuid" - }, { "description": "the description of the load balancer rule", "length": 4096, @@ -122263,6 +122255,14 @@ "required": false, "type": "string" }, + { + "description": "the ID of the global load balancer rule", + "length": 255, + "name": "id", + "related": "updateGlobalLoadBalancerRule", + "required": true, + "type": "uuid" + }, { "description": "session sticky method (sourceip) if not specified defaults to sourceip", "length": 255, @@ -122273,30 +122273,15 @@ ], "related": "", "response": [ - { - "description": "name of the global load balancer rule", - "name": "name", - "type": "string" - }, - { - "description": "the description of the global load balancer rule", - "name": "description", - "type": "string" - }, - { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", - "type": "string" - }, {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { @@ -122304,28 +122289,33 @@ "name": "loadbalancerrule", "response": [ { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "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" }, { @@ -122334,13 +122324,13 @@ "type": "boolean" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -122348,63 +122338,73 @@ "name": "domainid", "type": "string" }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "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 list of resource tags associated with load balancer", "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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 project name where tag belongs to", + "name": "project", "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": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], @@ -122415,93 +122415,77 @@ "name": "publicip", "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 public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, { "description": "the name of the load balancer", "name": "name", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "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", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, - {}, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" + "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": "GSLB service type", + "name": "gslbservicetype", + "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { @@ -122510,9 +122494,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" }, { "description": "global load balancer rule ID", @@ -122520,13 +122504,29 @@ "type": "string" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the description of the global load balancer rule", + "name": "description", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" } ] @@ -122537,43 +122537,37 @@ "name": "listHostTags", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "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": "", "response": [ { - "description": "the host ID of the host tag", - "name": "hostid", - "type": "long" - }, - {}, - { - "description": "the ID of the host tag", - "name": "id", + "description": "the name of the host tag", + "name": "name", "type": "string" }, { - "description": "the name of the host tag", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -122581,17 +122575,23 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the host tag", + "name": "id", + "type": "string" + }, { "description": "true if the host tag is implicit", "name": "isimplicit", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + "description": "the host ID of the host tag", + "name": "hostid", + "type": "long" + }, + {}, + {} ] }, { @@ -122599,20 +122599,6 @@ "isasync": true, "name": "addGuestOs", "params": [ - { - "description": "Optional name for Guest OS", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, { "description": "Unique display name for Guest OS", "length": 255, @@ -122634,20 +122620,33 @@ "name": "forDisplay", "required": false, "type": "boolean" + }, + { + "description": "Map of (key/value pairs)", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "Optional name for Guest OS", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the name of the OS category", - "name": "oscategoryname", + "description": "the ID of the OS type", + "name": "id", "type": "string" }, - {}, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" + "description": "the ID of the OS category", + "name": "oscategoryid", + "type": "string" }, { "description": "the name of the OS type", @@ -122655,21 +122654,15 @@ "type": "string" }, { - "description": "the ID of the OS category", - "name": "oscategoryid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name/description of the OS type", + "name": "description", "type": "string" }, { - "description": "the ID of the OS type", - "name": "id", - "type": "string" + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" }, - {}, { "description": "is the guest OS visible for the users", "name": "fordisplay", @@ -122680,9 +122673,16 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the name/description of the OS type", - "name": "description", + "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", "type": "string" } ], @@ -122693,13 +122693,6 @@ "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 id of the entity to annotate", "length": 255, @@ -122715,6 +122708,13 @@ "since": "4.16.0", "type": "boolean" }, + { + "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 annotation text", "length": 255, @@ -122725,51 +122725,46 @@ ], "related": "", "response": [ + { + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" + }, { "description": "the removal timestamp for this annotation", "name": "removed", "type": "date" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, + {}, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" - }, - { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, - {}, - {}, { "description": "The username of the user that entered the annotation", "name": "username", "type": "string" }, + {}, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" - }, - { - "description": "the contents of the annotation", - "name": "annotation", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { @@ -122778,14 +122773,19 @@ "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", - "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" + }, + { + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" } ], "since": "4.11" @@ -122795,11 +122795,19 @@ "isasync": true, "name": "deployNetscalerVpx", "params": [ + { + "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": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, @@ -122818,104 +122826,96 @@ "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" - }, - { - "description": "availability zone for the virtual machine", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" } ], "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter", "response": [ { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the public interface of the load balancer", + "name": "publicinterface", "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 physical network to which this netscaler 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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "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": "true if device is dedicated for an account", "name": "lbdevicededicated", "type": "boolean" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" }, {}, { - "description": "name of the provider", - "name": "provider", + "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": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" } ] }, @@ -122934,31 +122934,26 @@ ], "related": "", "response": [ - {}, - { - "description": "graceallowed", - "name": "graceallowed", - "type": "string" - }, { "description": "compression", "name": "compression", "type": "string" }, + {}, { - "description": "the id of the volume", - "name": "id", + "description": "synchronization", + "name": "sync", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the volume", + "name": "id", "type": "string" }, { - "description": "deduplication", - "name": "deduplication", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the name of the volume", @@ -122966,16 +122961,21 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "graceallowed", + "name": "graceallowed", + "type": "string" }, + {}, { - "description": "synchronization", - "name": "sync", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {} + { + "description": "deduplication", + "name": "deduplication", + "type": "string" + } ] }, { @@ -122984,26 +122984,18 @@ "name": "addBaremetalPxeKickStartServer", "params": [ { - "description": "Pod Id", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "URL of the external pxe device", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "url", + "name": "password", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Pod Id", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, "type": "uuid" }, { @@ -123014,9 +123006,9 @@ "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "password", + "name": "tftpdir", "required": true, "type": "string" }, @@ -123028,20 +123020,23 @@ "type": "string" }, { - "description": "Tftp root directory of PXE server", + "description": "the Physical Network ID", "length": 255, - "name": "tftpdir", + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "URL of the external pxe device", + "length": 255, + "name": "url", "required": true, "type": "string" } ], "related": "", "response": [ - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, {}, { "description": "device id of ", @@ -123049,16 +123044,26 @@ "type": "string" }, { - "description": "url", - "name": "url", + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "url", + "name": "url", + "type": "string" + }, { "description": "the physical network to which this external dhcp device belongs to", "name": "physicalnetworkid", @@ -123068,11 +123073,6 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", - "type": "string" } ] }, @@ -123096,13 +123096,6 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -123117,33 +123110,42 @@ "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": false, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "addNiciraNvpDevice", "response": [ { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, + {}, + {}, { - "description": "device name", - "name": "niciradevicename", + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -123152,13 +123154,8 @@ "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", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, { @@ -123167,12 +123164,15 @@ "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, - {}, - {} + { + "description": "device name", + "name": "niciradevicename", + "type": "string" + } ] }, { @@ -123181,58 +123181,53 @@ "name": "listAlerts", "params": [ { - "description": "list by alert type", + "description": "the ID of the alert", "length": 255, - "name": "type", + "name": "id", + "related": "listAlerts", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list by alert name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "since": "4.3", - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the alert", + "description": "list by alert name", "length": 255, - "name": "id", - "related": "listAlerts", + "name": "name", "required": false, - "type": "uuid" + "since": "4.3", + "type": "string" }, { - "description": "", + "description": "list by alert type", "length": 255, - "name": "page", + "name": "type", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ {}, - { - "description": "the id of the alert", - "name": "id", - "type": "string" - }, { "description": "description of the alert", "name": "description", @@ -123243,6 +123238,17 @@ "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "the date and time the alert was sent", + "name": "sent", + "type": "date" + }, + { + "description": "the id of the alert", + "name": "id", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -123257,12 +123263,6 @@ "description": "the name of the alert", "name": "name", "type": "string" - }, - {}, - { - "description": "the date and time the alert was sent", - "name": "sent", - "type": "date" } ] }, @@ -123279,22 +123279,6 @@ "since": "4.15", "type": "map" }, - { - "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 custom parameters. 'extraconfig' is not allowed to be passed in details", - "length": 255, - "name": "details", - "required": false, - "since": "4.3", - "type": "map" - }, { "description": "availability zone for the virtual machine", "length": 255, @@ -123304,19 +123288,12 @@ "type": "uuid" }, { - "description": "true if virtual machine needs to be dynamically scalable", - "length": 255, - "name": "dynamicscalingenabled", - "required": false, - "since": "4.16", - "type": "boolean" - }, - { - "description": "the ipv6 address for default vm's network", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "ip6address", + "name": "keypairs", "required": false, - "type": "string" + "since": "4.17", + "type": "list" }, { "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", @@ -123328,71 +123305,49 @@ "type": "uuid" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", - "length": 255, - "name": "size", - "required": false, - "type": "long" - }, - { - "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": "an optional user generated name for the virtual machine", - "length": 255, - "name": "displayname", - "required": false, - "type": "string" - }, - { - "description": "the mac address for default vm's network", + "description": "host name for the virtual machine", "length": 255, - "name": "macaddress", + "name": "name", "required": false, "type": "string" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "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": "podid", - "related": "createManagementNetworkIpRange", + "name": "nicnetworklist", "required": false, - "since": "4.13", - "type": "uuid" + "since": "4.15", + "type": "map" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "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": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "securitygroupnames", + "related": "", "required": false, "type": "list" }, { - "description": "the ip address for default vm's network", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "ipaddress", + "name": "keypair", "required": false, "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.", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "bootmode", - "required": false, - "since": "4.14.0.0", - "type": "string" + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "Controls specific policies on IO", - "length": 255, - "name": "iodriverpolicy", + "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" }, { @@ -123402,21 +123357,6 @@ "required": false, "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 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": "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, @@ -123426,152 +123366,152 @@ "type": "uuid" }, { - "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": "destination Cluster ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "clusterid", + "related": "addCluster", "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", "required": false, - "since": "4.12", - "type": "string" + "since": "4.2", + "type": "boolean" }, { - "description": "an optional group for the virtual machine", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "group", + "name": "nicmultiqueuenumber", "required": false, - "type": "string" + "since": "4.18", + "type": "integer" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "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": "displayvm", + "name": "keyboard", "required": false, - "since": "4.2", - "type": "boolean" + "type": "string" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "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": "bootintosetup", + "name": "datadiskofferinglist", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "since": "4.11", + "type": "map" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "keypair", + "name": "deploymentplanner", "required": false, + "since": "4.4", "type": "string" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "nicmultiqueuenumber", + "name": "nicpackedvirtqueuesenabled", "required": false, "since": "4.18", - "type": "integer" + "type": "boolean" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "keypairs", + "name": "displayname", "required": false, - "since": "4.17", - "type": "list" + "type": "string" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "deploymentplanner", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "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": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "keyboard", + "name": "account", "required": false, "type": "string" }, { - "description": "the ID of the Userdata", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "userdataid", - "related": "", + "name": "userdatadetails", "required": false, "since": "4.18", - "type": "uuid" + "type": "map" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "since": "4.13", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, "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": "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": "nicnetworklist", + "name": "boottype", "required": false, - "since": "4.15", - "type": "map" + "since": "4.14.0.0", + "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": "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": "datadiskofferinglist", + "name": "rootdisksize", "required": false, - "since": "4.11", - "type": "map" + "since": "4.4", + "type": "long" }, { - "description": "host name for the virtual machine", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "name", + "name": "details", "required": false, - "type": "string" + "since": "4.3", + "type": "map" }, { - "description": "Enable packed virtqueues or not.", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "startvm", "required": false, - "since": "4.18", "type": "boolean" }, { - "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": "Deploy vm for the project", "length": 255, - "name": "iothreadsenabled", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "customid", + "name": "bootintosetup", "required": false, - "type": "string" + "since": "4.15.0.0", + "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.", + "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": "boottype", + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.14.0.0", - "type": "string" + "type": "map" }, { "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", @@ -123582,12 +123522,18 @@ "type": "list" }, { - "description": "Deploy vm for the project", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "projectid", - "related": "", + "name": "size", "required": false, - "type": "uuid" + "type": "long" + }, + { + "description": "Controls specific policies on IO", + "length": 255, + "name": "iodriverpolicy", + "required": false, + "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", @@ -123605,50 +123551,70 @@ "type": "map" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "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": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" + }, + { + "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": "true if start vm after creating; defaulted to true if not specified", + "description": "an optional group for the virtual machine", "length": 255, - "name": "startvm", + "name": "group", + "required": false, + "type": "string" + }, + { + "description": "the ipv6 address for default vm's network", + "length": 255, + "name": "ip6address", + "required": false, + "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 ID of the template for the virtual machine", + "description": "the mac address for default vm's network", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "name": "macaddress", + "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", + "description": "the ip address for default vm's network", "length": 255, - "name": "affinitygroupnames", - "related": "", + "name": "ipaddress", "required": false, - "type": "list" + "type": "string" }, { - "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": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "hypervisor", + "name": "customid", "required": false, "type": "string" }, { - "description": "the ID of the service offering for the virtual machine", + "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": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "bootmode", + "required": false, + "since": "4.14.0.0", + "type": "string" }, { "description": "if true the image tags (if any) will be copied to the VM, default value is false", @@ -123659,97 +123625,274 @@ "type": "boolean" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "the ID of the Userdata", "length": 255, - "name": "userdatadetails", + "name": "userdataid", + "related": "", "required": false, "since": "4.18", - "type": "map" + "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "account", + "name": "dynamicscalingenabled", + "required": false, + "since": "4.16", + "type": "boolean" + }, + { + "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 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": "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": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "since": "4.13", + "type": "uuid" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "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 state of the virtual machine", - "name": "state", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "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": "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": "true if high-availability is enabled, false otherwise", "name": "haenable", "type": "boolean" }, + {}, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ID of the nic", + "name": "id", + "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": "Type of adapter if available", + "name": "adaptertype", + "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": "the traffic type of the nic", + "name": "traffictype", + "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": "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 gateway of IPv6 network", + "name": "ip6gateway", + "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 netmask of the nic", + "name": "netmask", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "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 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": "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "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 name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { "description": "Base64 string representation of the resource icon", @@ -123757,33 +123900,33 @@ "type": "resourceiconresponse" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "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 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 format of the template for the virtual machine", - "name": "templateformat", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -123792,8 +123935,8 @@ "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { @@ -123802,218 +123945,172 @@ "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, { "description": "the ID of the ISO attached to the virtual machine", "name": "isoid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "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": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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", + "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 VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, + {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the domain associated with the tag", + "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", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name of the affinity group", + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "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 service offering of the virtual machine", + "name": "serviceofferingid", "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -124021,271 +124118,63 @@ "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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 gateway of the nic", - "name": "gateway", - "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": "the name of the corresponding network", - "name": "networkname", - "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 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 IPv6 address of network", - "name": "ip6address", - "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": "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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": "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - } - ], - "type": "set" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, - {}, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { "description": "the control state of the host for the virtual machine", "name": "hostcontrolstate", "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": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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 vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { @@ -124294,19 +124183,19 @@ "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "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 vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { "description": "the project id of the vm", @@ -124314,95 +124203,146 @@ "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "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 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": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "tag value", - "name": "value", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" } ], "type": "set" }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "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 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", + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + {}, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -124411,80 +124351,132 @@ "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "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 ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "account owning the security group rule", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "tag value", + "name": "value", "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "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": "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 project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "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 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": "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", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -124493,97 +124485,127 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "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 ingress rules associated with the security group", + "name": "ingressrule", "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "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", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "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": "the account associated with the tag", + "name": "account", "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" }, { @@ -124592,31 +124614,36 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "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" }, { @@ -124629,119 +124656,42 @@ "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" - } - ], - "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": "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "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": "tag key name", - "name": "key", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "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 domain ID of the security group", - "name": "domainid", - "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 account owning the security group", + "name": "account", + "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -124750,22 +124700,72 @@ "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 account owning the security group", - "name": "account", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the name of the security group", + "name": "name", "type": "string" } ], "type": "set" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "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 pool type of the virtual machine", + "name": "pooltype", + "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" } ] }, @@ -124775,50 +124775,50 @@ "name": "listVolumes", "params": [ { - "description": "List resources by tags (key/value pairs)", + "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": "tags", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "map" + "since": "4.19.1", + "type": "uuid" }, { - "description": "list only volumes that are encrypted", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isencrypted", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.19.1", - "type": "boolean" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the name of the disk volume", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "page", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "the ID of the availability zone", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list volumes by disk offering", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "displayvolume", "required": false, "since": "4.4", - "type": "uuid" + "type": "boolean" }, { "description": "", @@ -124828,66 +124828,51 @@ "type": "integer" }, { - "description": "list volumes on specified host", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "projectid", - "related": "", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { - "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": "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 pod id the disk volume belongs to", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", + "description": "List by keyword", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "keyword", "required": false, - "since": "4.19.1", - "type": "uuid" + "type": "string" }, { - "description": "the cluster id the disk volume belongs to", + "description": "list only volumes that are encrypted", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "isencrypted", "required": false, - "type": "uuid" + "since": "4.19.1", + "type": "boolean" }, { - "description": "List by keyword", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "keyword", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, + "since": "4.3", "type": "string" }, { @@ -124898,20 +124883,18 @@ "type": "string" }, { - "description": "the ID of the virtual machine", + "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": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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": "listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "the IDs of the volumes, mutually exclusive with id", @@ -124923,94 +124906,142 @@ "type": "list" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list volumes by disk offering", "length": 255, - "name": "displayvolume", + "name": "diskofferingid", + "related": "", "required": false, "since": "4.4", + "type": "uuid" + }, + { + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, "type": "boolean" }, { - "description": "the name of the disk volume", + "description": "the type of disk volume", "length": 255, - "name": "name", + "name": "type", "required": false, "type": "string" }, { - "description": "the ID of the disk volume", + "description": "list volumes on specified host", "length": 255, - "name": "id", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "the ID of the virtual machine", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "virtualmachineid", + "related": "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, - "since": "4.3", - "type": "string" + "type": "uuid" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "state", + "name": "listsystemvms", "required": false, - "type": "string" + "since": "4.18", + "type": "boolean" }, { - "description": "the type of disk volume", + "description": "the ID of the disk volume", "length": 255, - "name": "type", + "name": "id", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "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" + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { "description": "ID of the disk volume", "name": "id", "type": "string" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -125019,29 +125050,29 @@ "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { "description": "IO requests read rate of the disk volume per the disk offering", @@ -125049,89 +125080,108 @@ "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "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": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", - "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 account associated with the disk volume", - "name": "account", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "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 availability zone", - "name": "zoneid", + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -125139,267 +125189,217 @@ "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": "id of the resource", - "name": "resourceid", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "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" }, { - "description": "resource type", - "name": "resourcetype", + "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" } ], "type": "set" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - {}, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "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 project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if volume 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 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 ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "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", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, { "description": "the format of the disk encryption if applicable", "name": "encryptformat", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, + {}, { - "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": "the chain info of the volume", - "name": "chaininfo", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "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": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "cluster name where the volume is allocated", + "name": "clustername", "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": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "size of the disk volume", + "name": "size", "type": "long" } ] @@ -125409,6 +125409,13 @@ "isasync": true, "name": "createLBHealthCheckPolicy", "params": [ + { + "description": "Number of consecutive health check failures before declaring an instance unhealthy", + "length": 255, + "name": "unhealthythreshold", + "required": false, + "type": "integer" + }, { "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", "length": 255, @@ -125417,9 +125424,24 @@ "type": "integer" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "unhealthythreshold", + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "Amount of time between health checks (1 sec - 20940 sec)", + "length": 255, + "name": "intervaltime", + "required": false, + "type": "integer" + }, + { + "description": "Number of consecutive health check success before declaring an instance healthy", + "length": 255, + "name": "healthythreshold", "required": false, "type": "integer" }, @@ -125444,32 +125466,15 @@ "related": "", "required": true, "type": "uuid" - }, - { - "description": "Number of consecutive health check success before declaring an instance healthy", - "length": 255, - "name": "healthythreshold", - "required": false, - "type": "integer" - }, - { - "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": "Amount of time between health checks (1 sec - 20940 sec)", - "length": 255, - "name": "intervaltime", - "required": false, - "type": "integer" } ], "related": "", "response": [ + { + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", @@ -125479,29 +125484,14 @@ "name": "pingpath", "type": "string" }, - { - "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": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" - }, - { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", "type": "int" }, { @@ -125509,19 +125499,41 @@ "name": "id", "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": "Time to wait when receiving a response from the health check", - "name": "responsetime", + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" + }, + { + "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" } ], "type": "list" }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the domain ID of the HealthCheck policy", "name": "domainid", @@ -125537,28 +125549,16 @@ "name": "lbruleid", "type": "string" }, - {}, { "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" - }, - {} + } ], "since": "4.2.0" }, @@ -125587,59 +125587,28 @@ "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", "response": [ { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" - }, - { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "ID of the shared filesystem", - "name": "id", - "type": "string" - }, - { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "Name of the availability zone", - "name": "zonename", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { @@ -125648,37 +125617,37 @@ "type": "long" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "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 project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -125687,201 +125656,90 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "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": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the state of the shared filesystem", - "name": "state", - "type": "string" - }, - { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, - { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" - }, - { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" - }, - { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", - "type": "string" - }, - {}, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" - }, - { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, - { - "description": "Network name of the shared filesystem", - "name": "networkname", - "type": "string" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "type": "string" - }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of the nic", + "name": "gateway", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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": "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": "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 type of the nic", - "name": "type", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -125890,33 +125748,28 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the type of the nic", + "name": "type", "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -125925,18 +125778,18 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -125945,58 +125798,48 @@ "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 traffic type of the nic", - "name": "traffictype", + "description": "the name of the corresponding network", + "name": "networkname", "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "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": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -126005,21 +125848,178 @@ "type": "integer" }, { - "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" } ], "type": "list" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "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": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + {}, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "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": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "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": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" } ], @@ -126041,20 +126041,36 @@ ], "related": "disableUser,getUser,listUsers", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the user ID", + "name": "id", + "type": "string" }, { "description": "the user name", @@ -126062,116 +126078,100 @@ "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "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", + "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 user lastname", + "name": "lastname", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user ID", - "name": "id", + "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 type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the user email address", - "name": "email", - "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", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "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 name of the role", - "name": "rolename", + "description": "the user firstname", + "name": "firstname", "type": "string" }, - {}, { "description": "the domain ID of the user", "name": "domainid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the user lastname", - "name": "lastname", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the name of the role", + "name": "rolename", "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" } ] }, @@ -126182,17 +126182,6 @@ "params": [], "related": "", "response": [ - { - "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", @@ -126203,7 +126192,18 @@ "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 Cloudian connector enabled state", + "name": "enabled", + "type": "boolean" + }, + {} ], "since": "4.11.0" }, @@ -126220,60 +126220,76 @@ "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "IPV6 address to be assigned to a router in a shared network", "length": 255, - "name": "ip6cidr", + "name": "routeripv6", "required": false, + "since": "4.16", "type": "string" }, { - "description": "the AS Number of the network", + "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "asnumber", + "name": "netmask", "required": false, - "since": "4.20.0", - "type": "long" + "type": "string" }, { - "description": "Account that will own the network. Account should be under the selected domain", + "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "account", + "name": "gateway", "required": false, "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the beginning IP address in the network IP range", "length": 255, - "name": "startipv6", + "name": "startip", "required": false, "type": "string" }, { - "description": "the ID or VID of the network", + "description": "the physical network ID the network belongs to", "length": 255, - "name": "vlan", + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the first IPv4 DNS for the network", + "length": 255, + "name": "dns1", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the VPC network belongs to", + "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": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the beginning IP address in the network IP range", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "startip", + "name": "displaynetwork", "required": false, - "type": "string" + "type": "boolean" }, { - "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", + "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", "length": 255, - "name": "acltype", + "name": "bypassvlanoverlapcheck", + "required": false, + "type": "boolean" + }, + { + "description": "the display text of the network", + "length": 255, + "name": "displaytext", "required": false, "type": "string" }, @@ -126286,35 +126302,31 @@ "type": "uuid" }, { - "description": "the network offering ID", + "description": "Tungsten-Fabric virtual router the network belongs to", "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": true, - "type": "uuid" + "name": "tungstenvirtualrouteruuid", + "required": false, + "type": "string" }, { - "description": "Ids of the Bgp Peer for the network", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "bgppeerids", - "related": "", + "name": "ip6cidr", "required": false, - "since": "4.20.0", - "type": "list" + "type": "string" }, { - "description": "the display text of the network", + "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": "displaytext", + "name": "acltype", "required": false, "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 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 isolated private VLAN type for this network", "length": 255, - "name": "sourcenatipaddress", + "name": "isolatedpvlantype", "required": false, - "since": "4.19", "type": "string" }, { @@ -126325,88 +126337,96 @@ "type": "string" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "the ID or VID of the network", "length": 255, - "name": "hideipaddressusage", + "name": "vlan", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "network domain", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "networkdomain", + "name": "publicmtu", "required": false, - "type": "string" + "since": "4.18.0", + "type": "integer" }, { - "description": "ID of the network in an external system.", + "description": "the second IPv6 DNS for the network", "length": 255, - "name": "externalid", + "name": "ip6dns2", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "an optional project for the network", + "description": "the first IPv6 DNS for the network", "length": 255, - "name": "projectid", - "related": "", + "name": "ip6dns1", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "the second IPv6 DNS for the network", + "description": "IPV4 address to be assigned to a router in a shared network", "length": 255, - "name": "ip6dns2", + "name": "routerip", "required": false, - "since": "4.18.0", + "since": "4.16", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "the name of the network", "length": 255, - "name": "displaynetwork", + "name": "name", + "required": true, + "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 network this network is associated to. only available if create a Shared network", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "startipv6", "required": false, - "since": "4.17.0", - "type": "uuid" + "type": "string" }, { - "description": "MTU to be configured on the network VR's private interface(s)", + "description": "the zone ID for the network", "length": 255, - "name": "privatemtu", - "required": false, - "since": "4.18.0", - "type": "integer" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "IPV6 address to be assigned to a router in a shared network", + "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", "length": 255, - "name": "routeripv6", + "name": "cidrsize", "required": false, - "since": "4.16", - "type": "string" + "since": "4.20.0", + "type": "integer" }, { - "description": "the first IPv6 DNS for the network", + "description": "the second IPv4 DNS for the network", "length": 255, - "name": "ip6dns1", + "name": "dns2", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "the isolated private VLAN for this network", + "description": "MTU to be configured on the network VR's private interface(s)", "length": 255, - "name": "isolatedpvlan", + "name": "privatemtu", "required": false, - "type": "string" + "since": "4.18.0", + "type": "integer" }, { "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", @@ -126416,285 +126436,180 @@ "type": "boolean" }, { - "description": "the isolated private VLAN type for this network", - "length": 255, - "name": "isolatedpvlantype", - "required": false, - "type": "string" - }, - { - "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "description": "The network this network is associated to. only available if create a Shared network", "length": 255, - "name": "endip", + "name": "associatednetworkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "string" + "since": "4.17.0", + "type": "uuid" }, { - "description": "the name of the network", + "description": "the network offering ID", "length": 255, - "name": "name", + "name": "networkofferingid", + "related": "listNetworkOfferings", "required": true, - "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 netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", + "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": "netmask", + "name": "sourcenatipaddress", "required": false, + "since": "4.19", "type": "string" }, { - "description": "the second IPv4 DNS for the network", + "description": "the VPC network belongs to", "length": 255, - "name": "dns2", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { - "description": "the first IPv4 DNS for the network", + "description": "the AS Number of the network", "length": 255, - "name": "dns1", + "name": "asnumber", "required": false, - "since": "4.18.0", - "type": "string" + "since": "4.20.0", + "type": "long" }, { - "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", + "description": "Ids of the Bgp Peer for the network", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "bgppeerids", + "related": "", "required": false, - "type": "boolean" + "since": "4.20.0", + "type": "list" }, { - "description": "IPV4 address to be assigned to a router in a shared network", + "description": "Account that will own the network. Account should be under the selected domain", "length": 255, - "name": "routerip", + "name": "account", "required": false, - "since": "4.16", "type": "string" }, { - "description": "the physical network ID the network belongs to", + "description": "an optional project for the network", "length": 255, - "name": "physicalnetworkid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", + "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", "length": 255, - "name": "cidrsize", + "name": "endip", "required": false, - "since": "4.20.0", - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", + "description": "the isolated private VLAN for this network", "length": 255, - "name": "tungstenvirtualrouteruuid", + "name": "isolatedpvlan", "required": false, "type": "string" }, { - "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "network domain", "length": 255, - "name": "gateway", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "the zone ID for the network", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "ID of the network in an external system.", "length": 255, - "name": "publicmtu", + "name": "externalid", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "string" } ], "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "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 external id of the network", - "name": "externalid", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "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": "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": "the destination physical network", - "name": "destinationphysicalnetworkid", - "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 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 traffic type of the network", - "name": "traffictype", + "description": "the network domain", + "name": "networkdomain", "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": "related to what other network configuration", - "name": "related", - "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": "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", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "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", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { @@ -126708,29 +126623,35 @@ "type": "boolean" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" }, + {}, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "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": "ip4routes", + "type": "set" }, { "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", @@ -126738,19 +126659,19 @@ "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { "description": "the name of the network", @@ -126758,53 +126679,159 @@ "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the project name of the address", + "name": "project", + "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": "the capability value", + "name": "value", + "type": "string" + }, + { + "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" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the 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": "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" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -126813,122 +126840,157 @@ "type": "integer" }, { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, - {}, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "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": "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 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": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "list" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, - {}, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, { "description": "the total number of network traffic bytes sent", "name": "sentbytes", @@ -126940,126 +127002,64 @@ "type": "set" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the network's gateway", - "name": "gateway", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "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": "VPC the network belongs to", - "name": "vpcid", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the list of resource tags associated with network", - "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 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 key name", - "name": "key", - "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" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" + "description": "the owner of the network", + "name": "account", + "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" } ] }, @@ -127069,11 +127069,11 @@ "name": "listNetworkOfferings", "params": [ { - "description": "list network offerings by guest type: shared or isolated", + "description": "the network offering can be used only for network creation inside the VPC", "length": 255, - "name": "guestiptype", + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the tags for the network offering.", @@ -127083,25 +127083,32 @@ "type": "boolean" }, { - "description": "true if offering has tags specified", + "description": "list network offerings by state", "length": 255, - "name": "istagged", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network offerings by tags", - "length": 4096, - "name": "tags", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list network offerings by guest type: shared or isolated", + "length": 255, + "name": "guestiptype", "required": false, "type": "string" }, { - "description": "true if need to list only network offerings which support specifying ip ranges", + "description": "the availability of network offering. Default value is required", "length": 255, - "name": "specifyipranges", + "name": "availability", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list network offerings by ID", @@ -127112,33 +127119,34 @@ "type": "uuid" }, { - "description": "list network offerings by state", + "description": "true if offering has tags specified", "length": 255, - "name": "state", + "name": "istagged", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list network offerings supporting certain services", + "description": "true if need to list only network offerings which support specifying ip ranges", "length": 255, - "name": "supportedservices", + "name": "specifyipranges", "required": false, - "type": "list" + "type": "boolean" }, { - "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.", + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "routingmode", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "string" }, { - "description": "", + "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": "pagesize", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "true if need to list only default network offerings. Default value is false", @@ -127155,122 +127163,123 @@ "type": "string" }, { - "description": "list network offerings available for network creation in specific zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "list by traffic type", + "description": "list network offerings by name", "length": 255, - "name": "traffictype", + "name": "name", "required": false, "type": "string" }, { - "description": "the network offering can be used only for network creation inside the VPC", + "description": "list network offerings by display text", "length": 255, - "name": "forvpc", + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network offerings available for network creation in specific domain", - "length": 255, - "name": "domainid", - "related": "listDomains", + "description": "list network offerings by tags", + "length": 4096, + "name": "tags", "required": false, - "since": "4.13", - "type": "uuid" + "type": "string" }, { - "description": "list network offerings by display text", + "description": "list by traffic type", "length": 255, - "name": "displaytext", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "", + "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", "length": 255, - "name": "page", + "name": "sourcenatsupported", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list network offerings by name", + "description": "list network offerings supporting certain services", "length": 255, - "name": "name", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "the availability of network offering. Default value is required", + "description": "list network offerings available for network creation in specific domain", "length": 255, - "name": "availability", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "since": "4.13", + "type": "uuid" }, { - "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", + "description": "", "length": 255, - "name": "sourcenatsupported", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "description": "list network offerings available for network creation in specific zone", "length": 255, - "name": "routingmode", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.20.0", - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "the name of the network offering", + "name": "name", + "type": "string" + }, + { + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", "type": "boolean" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", - "type": "string" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - {}, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "type": "boolean" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", + "description": "the tags for the network offering", + "name": "tags", + "type": "string" + }, + { + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", "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 default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "additional key/value details tied with network offering", @@ -127278,18 +127287,18 @@ "type": "map" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "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": "true if network offering can be used by NSX networks only", - "name": "fornsx", + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", "type": "boolean" }, { @@ -127298,40 +127307,87 @@ "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", "type": "boolean" }, { - "description": "the name of the network offering", - "name": "name", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "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", + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" + }, + { + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" + }, + { + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", "type": "boolean" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "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": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + {}, { "description": "the list of supported services", "name": "service", @@ -127341,8 +127397,8 @@ "name": "provider", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -127356,23 +127412,23 @@ "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, { "description": "uuid of the network provider", "name": "id", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], @@ -127388,8 +127444,8 @@ "name": "capability", "response": [ { - "description": "the capability name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" }, { @@ -127398,8 +127454,8 @@ "type": "boolean" }, { - "description": "the capability value", - "name": "value", + "description": "the capability name", + "name": "name", "type": "string" } ], @@ -127409,86 +127465,30 @@ "type": "list" }, { - "description": "the id of the network offering", - "name": "id", - "type": "string" - }, - { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - }, - { - "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 supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "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": "availability of the network offering", - "name": "availability", + "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 public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" - }, - { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "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" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the id of the network offering", + "name": "id", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "availability of the network offering", + "name": "availability", "type": "string" - }, - {} + } ] }, { @@ -127497,19 +127497,18 @@ "name": "listDedicatedPods", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list dedicated pods by affinity group", + "description": "", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the name of the account associated with the pod. Must be used with domainId.", @@ -127527,71 +127526,72 @@ "type": "uuid" }, { - "description": "the ID of the domain associated with the pod", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of the domain associated with the pod", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list dedicated pods by affinity group", "length": 255, - "name": "pagesize", + "name": "affinitygroupid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ + {}, {}, { - "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", - "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", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Pod", + "name": "podid", "type": "string" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, { - "description": "the Name of the Pod", - "name": "podname", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "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 Name of the Pod", + "name": "podname", + "type": "string" } ] }, @@ -127601,77 +127601,78 @@ "name": "listVPCs", "params": [ { - "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "List by keyword", "length": 255, - "name": "cidr", + "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.", + "description": "list by name of the VPC", "length": 255, - "name": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list VPC supporting certain services", + "description": "list VPCs by state", "length": 255, - "name": "supportedservices", + "name": "state", "required": false, - "type": "list" + "type": "string" }, { - "description": "list by zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by display text of the VPC", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "displaytext", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list VPC by id", + "description": "list by ID of the VPC offering", "length": 255, - "name": "id", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "vpcofferingid", + "related": "updateVPCOffering", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "flag to display the resource icon for VPCs", "length": 255, - "name": "isrecursive", + "name": "showicon", "required": false, "type": "boolean" }, { - "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": "flag to display the resource icon for VPCs", + "description": "list VPC by id", "length": 255, - "name": "showicon", + "name": "id", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "boolean" + "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": "listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -127681,152 +127682,165 @@ "type": "string" }, { - "description": "list VPCs by restartRequired option", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "restartrequired", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "list VPCs by state", + "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 by keyword", + "description": "list VPC supporting certain services", "length": 255, - "name": "keyword", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "list by ID of the VPC offering", + "description": "list VPCs by restartRequired option", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "restartrequired", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list by zone", "length": 255, - "name": "tags", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "projectid", - "related": "", + "name": "cidr", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by display text of the VPC", "length": 255, - "name": "fordisplay", + "name": "displaytext", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "list by name of the VPC", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "name", + "name": "tags", "required": false, - "type": "string" + "type": "map" } ], "related": "createVPC,listVPCs,updateVPC", "response": [ - {}, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the owner of the VPC", + "name": "account", + "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "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": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "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": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 name where tag belongs to", + "name": "project", "type": "string" }, { @@ -127835,87 +127849,26 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], - "type": "list" - }, - { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - { - "description": "the owner of the VPC", - "name": "account", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "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 id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "type": "list" }, - {}, { "description": "is vpc for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the project name of the VPC", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { @@ -127924,23 +127877,23 @@ "type": "boolean" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { @@ -127948,42 +127901,54 @@ "name": "cidr", "type": "string" }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, - { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" - }, { "description": "AS NUMBER", "name": "asnumber", "type": "long" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the list of supported services", "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "state of the network provider", - "name": "state", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the capability name", + "name": "name", + "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -127991,162 +127956,130 @@ "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", + "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": "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", + "description": "uuid of the network provider", + "name": "id", "type": "string" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "the id of the VPC", - "name": "id", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "the name of the VPC", - "name": "name", - "type": "string" + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, + {}, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" - } - ] - }, - { - "description": "Execute network-utility command (ping/arping/tracert) on system VMs remotely", - "isasync": true, - "name": "runDiagnostics", - "params": [ + }, { - "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", - "length": 255, - "name": "type", - "required": true, + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "The IP/Domain address to test connection to", - "length": 255, - "name": "ipaddress", - "required": true, + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "The ID of the system VM instance to diagnose", - "length": 255, - "name": "targetid", - "related": "startSystemVm", - "required": true, - "type": "uuid" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "Additional command line options that apply for each command", - "length": 255, - "name": "params", - "required": false, + "description": "the domain name of the owner", + "name": "domain", "type": "string" - } - ], - "related": "", - "response": [ + }, + {}, { - "description": "the standard error output from the command execution", - "name": "stderr", - "type": "string" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" }, { - "description": "the command execution return code", - "name": "exitcode", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the standard output from the command execution", - "name": "stdout", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" } - ], - "since": "4.12.0.0" + ] }, { "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", @@ -128170,6 +128103,13 @@ ], "related": "", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, { "description": "the ID of the network device", "name": "id", @@ -128179,36 +128119,81 @@ "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": "Restarts a VPC", + "description": "Execute network-utility command (ping/arping/tracert) on system VMs remotely", "isasync": true, - "name": "restartVPC", + "name": "runDiagnostics", "params": [ { - "description": "Turn a single VPC into a redundant one.", + "description": "Additional command line options that apply for each command", "length": 255, - "name": "makeredundant", + "name": "params", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the id of the VPC", + "description": "The ID of the system VM instance to diagnose", "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC", + "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 system VM diagnostics type valid options are: ping, traceroute, arping", + "length": 255, + "name": "type", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the standard output from the command execution", + "name": "stdout", + "type": "string" + }, + { + "description": "the command execution return code", + "name": "exitcode", + "type": "string" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the standard error output from the command execution", + "name": "stderr", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.12.0.0" + }, + { + "description": "Restarts a VPC", + "isasync": true, + "name": "restartVPC", + "params": [ { "description": "If cleanup old network elements", "length": 255, @@ -128223,30 +128208,45 @@ "required": false, "since": "4.17.0", "type": "boolean" + }, + { + "description": "Turn a single VPC into a redundant one.", + "length": 255, + "name": "makeredundant", + "required": false, + "type": "boolean" + }, + { + "description": "the id of the VPC", + "length": 255, + "name": "id", + "related": "createVPC,listVPCs,updateVPC", + "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": "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" } ] }, @@ -128256,19 +128256,11 @@ "name": "quotaConfigureEmail", "params": [ { - "description": "Account ID for which to configure quota template email or min balance", - "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts", - "required": true, - "type": "uuid" - }, - { - "description": "Quota email template name which should be configured", + "description": "If the quota email template should be enabled", "length": 255, - "name": "templatename", + "name": "enable", "required": false, - "type": "string" + "type": "boolean" }, { "description": "New quota account min balance", @@ -128278,21 +128270,30 @@ "type": "double" }, { - "description": "If the quota email template should be enabled", + "description": "Quota email template name which should be configured", "length": 255, - "name": "enable", + "name": "templatename", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "Account ID for which to configure quota template email or min balance", + "length": 255, + "name": "accountid", + "related": "enableAccount,listAccounts", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "The configured account's min balance.", - "name": "minbalance", - "type": "double" + "description": "The configured account's id.", + "name": "account", + "type": "string" }, {}, + {}, { "description": "Whether the template is enabled.", "name": "enabled", @@ -128303,22 +128304,21 @@ "name": "templatename", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The configured account's id.", - "name": "account", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + { + "description": "The configured account's min balance.", + "name": "minbalance", + "type": "double" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.20.0.0" }, @@ -128328,23 +128328,23 @@ "name": "addBaremetalDhcp", "params": [ { - "description": "Credentials to reach external dhcp device", + "description": "URL of the external dhcp appliance.", "length": 255, - "name": "username", + "name": "url", "required": true, "type": "string" }, { - "description": "URL of the external dhcp appliance.", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "url", + "name": "username", "required": true, "type": "string" }, { - "description": "Type of dhcp device", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "dhcpservertype", + "name": "password", "required": true, "type": "string" }, @@ -128357,9 +128357,9 @@ "type": "uuid" }, { - "description": "Credentials to reach external dhcp device", + "description": "Type of dhcp device", "length": 255, - "name": "password", + "name": "dhcpservertype", "required": true, "type": "string" } @@ -128367,13 +128367,8 @@ "related": "listBaremetalDhcp", "response": [ { - "description": "device id of ", - "name": "id", - "type": "string" - }, - { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -128381,27 +128376,32 @@ "name": "dhcpservertype", "type": "string" }, - {}, { - "description": "name of the provider", - "name": "provider", + "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": "device id of ", + "name": "id", + "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" } ] }, @@ -128427,28 +128427,28 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -128464,14 +128464,6 @@ "required": false, "type": "list" }, - { - "description": "the ID of the snapshot.", - "length": 255, - "name": "id", - "related": "copySnapshot,listSnapshots", - "required": true, - "type": "uuid" - }, { "description": "The ID of the zone the snapshot is being copied to.", "length": 255, @@ -128487,132 +128479,71 @@ "related": "listZones", "required": false, "type": "uuid" + }, + { + "description": "the ID of the snapshot.", + "length": 255, + "name": "id", + "related": "copySnapshot,listSnapshots", + "required": true, + "type": "uuid" } ], "related": "listSnapshots", "response": [ { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, - { - "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": "customer associated with the tag", - "name": "customer", - "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 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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, - {}, - {}, { - "description": "name of the snapshot", - "name": "name", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "type of the disk volume", - "name": "volumetype", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", "type": "long" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, - { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, { "description": "name of the disk volume", "name": "volumename", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "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": "state of the disk volume", + "name": "volumestate", "type": "string" }, { @@ -128620,19 +128551,30 @@ "name": "domainpath", "type": "string" }, + {}, { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { @@ -128641,84 +128583,142 @@ "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "type of the disk volume", + "name": "volumetype", + "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": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "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": "tag value", + "name": "value", + "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 availability zone", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" } ], "since": "4.19.0" @@ -128736,12 +128736,11 @@ "type": "string" }, { - "description": "Zone in which to add the external firewall appliance.", + "description": "Traffic going into the listed zones will be metered", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "includezones", + "required": false, + "type": "string" }, { "description": "Traffic going into the listed zones will not be metered", @@ -128751,23 +128750,19 @@ "type": "string" }, { - "description": "Traffic going into the listed zones will be metered", + "description": "Zone in which to add the external firewall appliance.", "length": 255, - "name": "includezones", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" - }, - { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { @@ -128775,12 +128770,6 @@ "name": "ipaddress", "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", "name": "jobstatus", @@ -128791,11 +128780,22 @@ "name": "jobid", "type": "string" }, + {}, + { + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" + }, { "description": "the ID of the external firewall", "name": "id", "type": "string" }, + { + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" + }, {} ] }, @@ -128805,62 +128805,55 @@ "name": "listUsers", "params": [ { - "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 only resources belonging to the domain specified", + "description": "List user by ID.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "id", + "related": "disableUser,getUser,listUsers", "required": false, "type": "uuid" }, { - "description": "", + "description": "List user by the username", "length": 255, - "name": "page", + "name": "username", "required": false, - "type": "integer" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "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": "flag to display the resource icon for users", + "description": "List users by state of the user account.", "length": 255, - "name": "showicon", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List user by ID.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "disableUser,getUser,listUsers", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "List users by state of the user account.", + "description": "flag to display the resource icon for users", "length": 255, - "name": "state", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -128870,104 +128863,111 @@ "type": "integer" }, { - "description": "List user by the username", + "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": "username", + "name": "listall", "required": false, - "type": "string" + "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", "length": 255, - "name": "account", + "name": "accounttype", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "disableUser,getUser", "response": [ { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the user state", + "name": "state", + "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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 type of the role", - "name": "roletype", + "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 enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, + {}, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the name of the role", + "name": "rolename", "type": "string" }, - {}, { "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", - "type": "string" + "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", @@ -128975,14 +128975,14 @@ "type": "boolean" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the user name", + "name": "username", + "type": "string" }, {}, { @@ -128991,9 +128991,9 @@ "type": "integer" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the account name of the user", @@ -129001,18 +129001,13 @@ "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the user name", - "name": "username", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -129021,8 +129016,13 @@ "type": "resourceiconresponse" }, { - "description": "the user state", - "name": "state", + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", "type": "string" } ] @@ -129032,6 +129032,35 @@ "isasync": false, "name": "updateVlanIpRange", "params": [ + { + "description": "the netmask of the VLAN IP range", + "length": 255, + "name": "netmask", + "required": false, + "type": "string" + }, + { + "description": "the UUID of the VLAN IP range", + "length": 255, + "name": "id", + "related": "updateVlanIpRange", + "required": true, + "type": "uuid" + }, + { + "description": "true if IP range is set to system vms, false if not", + "length": 255, + "name": "forsystemvms", + "required": false, + "type": "boolean" + }, + { + "description": "the gateway of the VLAN IP range", + "length": 255, + "name": "gateway", + "required": false, + "type": "string" + }, { "description": "the ending IP address in the VLAN IP range", "length": 255, @@ -129046,13 +129075,6 @@ "required": false, "type": "string" }, - { - "description": "the netmask of the VLAN IP range", - "length": 255, - "name": "netmask", - "required": false, - "type": "string" - }, { "description": "the ending IPv6 address in the IPv6 network range", "length": 255, @@ -129060,13 +129082,6 @@ "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, @@ -129075,27 +129090,12 @@ "type": "string" }, { - "description": "the gateway of the VLAN IP range", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "gateway", + "name": "ip6cidr", "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 UUID of the VLAN IP range", - "length": 255, - "name": "id", - "related": "updateVlanIpRange", - "required": true, - "type": "uuid" - }, { "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, @@ -129107,45 +129107,40 @@ "related": "", "response": [ { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, + {}, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "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 Pod name for the VLAN IP range", - "name": "podname", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "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 ID or VID of the VLAN.", + "name": "vlan", + "type": "string" }, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", - "type": "boolean" + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -129153,18 +129148,23 @@ "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { @@ -129172,15 +129172,14 @@ "name": "ip6gateway", "type": "string" }, - {}, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { @@ -129189,65 +129188,66 @@ "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", - "type": "string" + "description": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", + "type": "boolean" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", "type": "boolean" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" - } + }, + {} ], "since": "4.16.0" }, @@ -129257,34 +129257,26 @@ "name": "listResourceLimits", "params": [ { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "projectid", - "related": "", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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. ", + "description": "", "length": 255, - "name": "resourcetype", + "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" - }, { "description": "Lists resource limits by ID.", "length": 255, @@ -129293,19 +129285,20 @@ "type": "long" }, { - "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": "Tag for the resource type", "length": 255, - "name": "resourcetypename", + "name": "tag", "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "Tag for the resource type", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "tag", + "name": "projectid", + "related": "", "required": false, - "since": "4.20.0", - "type": "string" + "type": "uuid" }, { "description": "list only resources belonging to the domain specified", @@ -129316,96 +129309,103 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", + "name": "resourcetypename", "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": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "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": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", + "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" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", - "type": "string" - }, { "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", "name": "max", "type": "long" }, { - "description": "the project name of the resource limit", - "name": "project", + "description": "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": "path of the domain to which the resource limit belongs", - "name": "domainpath", + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" }, {}, { - "description": "The tag for the resource limit", - "name": "tag", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "the account of the resource limit", + "name": "account", "type": "string" }, { - "description": "the account of the resource limit", - "name": "account", + "description": "the domain ID of the resource limit", + "name": "domainid", "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 resource limit belongs", + "name": "domainpath", + "type": "string" + }, + {}, { "description": "the domain name of the resource limit", "name": "domain", "type": "string" }, { - "description": "the project id of the resource limit", - "name": "projectid", + "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": "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 project name of the resource limit", + "name": "project", + "type": "string" + }, + { + "description": "The tag for the resource limit", + "name": "tag", "type": "string" } ] @@ -129427,35 +129427,28 @@ "related": "getUser", "response": [ { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "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 account name of the user", - "name": "account", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { @@ -129464,20 +129457,31 @@ "type": "string" }, { - "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", + "description": "the user firstname", + "name": "firstname", "type": "string" }, + {}, { "description": "the account type of the user", "name": "accounttype", "type": "integer" }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, { "description": "the domain ID of the user", "name": "domainid", @@ -129488,75 +129492,71 @@ "name": "domain", "type": "string" }, + {}, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "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 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 source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the user email address", - "name": "email", - "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 name of the role", - "name": "rolename", - "type": "string" - }, { "description": "true if user has two factor authentication is mandated", "name": "is2famandated", "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "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 api key of the user", + "name": "apikey", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" } ] }, @@ -129566,35 +129566,14 @@ "name": "listIsos", "params": [ { - "description": "true if the ISO is publicly available to all users, false otherwise.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, - { - "description": "ID of the storage pool", + "description": "ID of the image or image cache store", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "imagestoreid", + "related": "listSwifts", "required": false, "since": "4.19", "type": "uuid" }, - { - "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": "list only resources belonging to the domain specified", "length": 255, @@ -129604,18 +129583,18 @@ "type": "uuid" }, { - "description": "the hypervisor for which to restrict the search", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "hypervisor", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "tags", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { "description": "If set to true, list only unique isos across zones", @@ -129626,70 +129605,71 @@ "type": "boolean" }, { - "description": "ID of the image or image cache store", + "description": "", "length": 255, - "name": "imagestoreid", - "related": "listSwifts", + "name": "page", "required": false, - "since": "4.19", - "type": "uuid" + "type": "integer" }, { - "description": "flag to display the resource image for the isos", + "description": "list ISO by ID", "length": 255, - "name": "showicon", + "name": "id", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "ID of the storage pool", "length": 255, - "name": "pagesize", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "integer" + "since": "4.19", + "type": "uuid" }, { - "description": "", + "description": "show removed ISOs as well", "length": 255, - "name": "page", + "name": "showremoved", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list ISO by ID", + "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.20", + "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 this ISO is ready to be deployed", "length": 255, - "name": "listall", + "name": "isready", "required": false, "type": "boolean" }, { - "description": "show removed ISOs as well", + "description": "true if the ISO is publicly available to all users, false otherwise.", "length": 255, - "name": "showremoved", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "true if the ISO is bootable, false otherwise", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "bootable", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -129700,9 +129680,24 @@ "type": "uuid" }, { - "description": "true if this ISO is ready to be deployed", + "description": "the ID of the zone", "length": 255, - "name": "isready", + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "length": 255, + "name": "bootable", "required": false, "type": "boolean" }, @@ -129714,45 +129709,60 @@ "type": "string" }, { - "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", + "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": "arch", + "name": "isofilter", "required": false, - "since": "4.20", "type": "string" }, { - "description": "the ID of the zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", "required": false, - "type": "uuid" + "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).", + "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": "isofilter", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "flag to display the resource image for the isos", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, { "description": "the account name to which the template belongs", "name": "account", "type": "string" }, { - "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", + "type": "boolean" }, { "description": "CPU Arch of the template", @@ -129760,13 +129770,8 @@ "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", + "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" }, { @@ -129775,13 +129780,59 @@ "type": "map" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "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": "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 format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "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": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { @@ -129790,77 +129841,138 @@ "type": "resourceiconresponse" }, { - "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" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the URL which the template/iso is registered from", + "name": "url", "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 type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "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": "checksum of the template", "name": "checksum", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "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 for this template", + "name": "zonename", + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "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", + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + {}, + { + "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 ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the project id of the template", + "name": "projectid", "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 template display text", + "name": "displaytext", + "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", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -129874,33 +129986,38 @@ "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 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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -129912,75 +130029,19 @@ "type": "set" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" - }, - {}, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" - }, { "description": "the physical size of the template", "name": "physicalsize", "type": "long" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "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": "true if template is sshkey enabled, false otherwise", @@ -129988,39 +130049,18 @@ "type": "boolean" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - {}, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "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": "the status of the template", + "name": "status", "type": "string" }, { - "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the project name of the template", + "name": "project", "type": "string" }, { @@ -130029,53 +130069,13 @@ "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "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", - "type": "string" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "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 project name of the template", - "name": "project", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" } ] @@ -130086,91 +130086,91 @@ "name": "listAutoScalePolicies", "params": [ { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, - "name": "keyword", + "name": "action", "required": false, "type": "string" }, { - "description": "the ID of the autoscale vm group", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "vmgroupid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "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": "action", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the name of the autoscale policy", "length": 255, - "name": "account", + "name": "name", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the autoscale policy", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "listAutoScalePolicies", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. 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": "the name of the autoscale policy", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the autoscale vm group", + "length": 255, + "name": "vmgroupid", "related": "", "required": false, "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": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "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 autoscale policy", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listAutoScalePolicies", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, @@ -130186,76 +130186,76 @@ "related": "", "response": [ { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, + {}, { "description": "the domain name of the autoscale policy", "name": "domain", "type": "string" }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "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", - "type": "integer" + "description": "the account owning the autoscale policy", + "name": "account", + "type": "string" }, { "description": "the autoscale policy ID", "name": "id", "type": "string" }, - { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" - }, - { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" - }, - { - "description": "name of the autoscale policy", - "name": "name", - "type": "string" - }, + {}, { "description": "the project name of the autoscale policy", "name": "project", "type": "string" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, - {}, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" + }, + { + "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" } ] }, @@ -130265,19 +130265,19 @@ "name": "dedicateIpv4SubnetForZone", "params": [ { - "description": "project who will own the IPv4 subnet", + "description": "account who will own the IPv4 subnet", "length": 255, - "name": "projectid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "account who will own the IPv4 subnet", + "description": "project who will own the IPv4 subnet", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "domain ID of the account owning the IPv4 subnet", @@ -130298,15 +130298,9 @@ ], "related": "", "response": [ - {}, - { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" - }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -130315,102 +130309,111 @@ "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "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": "date when this IPv4 subnet was created.", "name": "created", "type": "date" }, + {}, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "the account of the IPv4 subnet", + "name": "account", "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": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, - {}, { "description": "the domain ID of the IPv4 subnet", "name": "domainid", "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" } ], "since": "4.20.0" }, { - "description": "List Shared FileSystems", - "isasync": false, - "name": "listSharedFileSystems", + "description": "adds baremetal rack configuration text", + "isasync": true, + "name": "addBaremetalRct", "params": [ { - "description": "the ID of the network", + "description": "http url to baremetal RCT configuration", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": false, - "type": "uuid" - }, + "name": "baremetalrcturl", + "required": true, + "type": "object" + } + ], + "related": "", + "response": [ { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "url", + "name": "url", + "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 by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "id of rct", + "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": "List Shared FileSystems", + "isasync": false, + "name": "listSharedFileSystems", + "params": [ { - "description": "List resources by tags (key/value pairs)", + "description": "the ID of the availability zone", "length": 255, - "name": "tags", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "map" + "type": "uuid" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -130436,13 +130439,20 @@ "type": "uuid" }, { - "description": "the ID of the availability zone", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, + { + "description": "the name of the shared filesystem", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -130451,26 +130461,47 @@ "type": "string" }, { - "description": "makes the API's response contains only the resource count", + "description": "the ID of the shared filesystem", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "id", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", + "required": false, + "type": "uuid" + }, + { + "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": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the ID of the shared filesystem", + "description": "", "length": 255, - "name": "id", - "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the service offering of the shared filesystem", @@ -130481,24 +130512,62 @@ "type": "uuid" }, { - "description": "the name of the shared filesystem", + "description": "the ID of the network", "length": 255, - "name": "name", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" } ], "related": "changeSharedFileSystemDiskOffering", "response": [ { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", + "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": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" }, { "description": "the account associated with the shared filesystem", @@ -130506,23 +130575,23 @@ "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { @@ -130531,13 +130600,18 @@ "type": "boolean" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "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" }, { @@ -130545,33 +130619,28 @@ "name": "nic", "response": [ { - "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", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "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": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -130580,48 +130649,48 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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": "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 vm to which the nic belongs", + "name": "virtualmachineid", "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -130630,19 +130699,24 @@ "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 isolation uri of the nic", - "name": "isolationuri", + "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", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { "description": "the isolated private VLAN if available", @@ -130650,18 +130724,18 @@ "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "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", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -130670,134 +130744,73 @@ "type": "integer" }, { - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" } ], "type": "list" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "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": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", + "description": "size of the shared filesystem", + "name": "size", "type": "long" }, { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the state of the shared filesystem", - "name": "state", - "type": "string" - }, - {}, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the list of resource tags associated", "name": "tags", @@ -130808,8 +130821,8 @@ "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" }, { @@ -130817,29 +130830,24 @@ "name": "value", "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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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" }, { @@ -130848,8 +130856,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -130861,44 +130874,49 @@ "type": "set" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "type": "string" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, - {}, { - "description": "description of the shared filesystem", - "name": "description", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, + {}, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { @@ -130907,57 +130925,28 @@ "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "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", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "url", - "name": "url", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { @@ -130965,8 +130954,19 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, {} - ] + ], + "since": "4.20.0" }, { "description": "Updates a role", @@ -130974,11 +130974,12 @@ "name": "updateRole", "params": [ { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "ID of the role", "length": 255, - "name": "type", - "required": false, - "type": "string" + "name": "id", + "related": "listRoles,updateRole", + "required": true, + "type": "uuid" }, { "description": "creates a role with this unique name", @@ -130988,26 +130989,25 @@ "type": "string" }, { - "description": "The description of the role", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", "length": 255, - "name": "description", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", + "description": "The description of the role", "length": 255, - "name": "ispublic", + "name": "description", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "ID of the role", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "id", - "related": "listRoles,updateRole", - "required": true, - "type": "uuid" + "name": "type", + "required": false, + "type": "string" }, { "description": "The description of the role", @@ -131019,7 +131019,6 @@ ], "related": "listRoles", "response": [ - {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -131027,14 +131026,14 @@ "type": "string" }, { - "description": "the type of the role", - "name": "type", + "description": "the state of the role", + "name": "state", "type": "string" }, { - "description": "the ID of the role", - "name": "id", - "type": "string" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the name of the role", @@ -131042,13 +131041,19 @@ "type": "string" }, { - "description": "the state of the role", - "name": "state", + "description": "the description of the role", + "name": "description", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the type of the role", + "name": "type", + "type": "string" + }, + {}, + { + "description": "the ID of the role", + "name": "id", "type": "string" }, { @@ -131060,11 +131065,6 @@ "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": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" } ], "since": "4.9.0" @@ -131077,129 +131077,129 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "Lists remote access vpn rule with the specified ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "listRemoteAccessVpns", + "name": "projectid", + "related": "", "required": false, - "since": "4.3", "type": "uuid" }, { - "description": "list only resources belonging to the domain 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": "domainid", - "related": "listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list remote access VPNs for certain network", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "account", "required": false, - "since": "4.3", - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list remote access VPNs for certain network", "length": 255, - "name": "projectid", - "related": "", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, + "since": "4.3", "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "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": "public ip address id of the vpn server", "length": 255, - "name": "listall", + "name": "publicipid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "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": "public ip address id of the vpn server", + "description": "Lists remote access vpn rule with the specified ID", "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "id", + "related": "listRemoteAccessVpns", "required": false, + "since": "4.3", "type": "uuid" } ], "related": "", "response": [ { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" - }, - { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" + "description": "is vpn 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 name of the account of the remote access vpn", - "name": "domain", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "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": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", + "type": "string" }, - {}, { "description": "the public ip address of the vpn server", "name": "publicip", @@ -131210,40 +131210,40 @@ "name": "project", "type": "string" }, + {}, { - "description": "the state of the rule", - "name": "state", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "the state of the rule", + "name": "state", "type": "string" }, - {}, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" } ] @@ -131269,11 +131269,6 @@ "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", @@ -131284,6 +131279,11 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {} ], "since": "4.20.0" @@ -131304,11 +131304,10 @@ ], "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", @@ -131319,12 +131318,13 @@ "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" + } ] }, { @@ -131343,26 +131343,26 @@ ], "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", + "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" } ] }, @@ -131372,10 +131372,10 @@ "name": "createServiceInstance", "params": [ { - "description": "The service offering ID that defines the resources consumed by the service appliance", + "description": "The left (inside) network for service instance", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "leftnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": true, "type": "uuid" }, @@ -131386,6 +131386,22 @@ "required": true, "type": "string" }, + { + "description": "The service offering ID that defines the resources consumed by the service appliance", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "Project ID for the service instance", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "An optional account for the virtual machine. Must be used with domainId.", "length": 255, @@ -131405,26 +131421,10 @@ "description": "The template ID that specifies the image for the service appliance", "length": 255, "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - }, - { - "description": "The left (inside) network for service instance", - "length": 255, - "name": "leftnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, - { - "description": "Project ID for the service instance", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "The right (outside) network ID for the service instance", "length": 255, @@ -131445,29 +131445,30 @@ "related": "", "response": [ { - "description": "the project name of the vm", - "name": "project", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "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 domain in which the virtual machine exists", - "name": "domain", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { @@ -131481,24 +131482,23 @@ "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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 ID of the domain in which the virtual machine exists", + "name": "domainid", + "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": "path of the Domain in which the virtual machine exists", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -131524,112 +131524,96 @@ "name": "hypervisor", "type": "string" }, - { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" - }, - { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" - }, { "description": "the public netmask for the system VM", "name": "publicnetmask", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the first DNS for the system VM", + "name": "dns1", "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 Zone name for the system VM", "name": "zonename", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, {}, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, - {}, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "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 systemvm agent version", - "name": "version", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { "description": "the agent state of the system VM", @@ -131637,33 +131621,48 @@ "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "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 control state of the host for the system VM", + "name": "hostcontrolstate", "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", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", "type": "integer" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "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" }, { @@ -131672,63 +131671,64 @@ "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 hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "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", - "type": "integer" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the name of the system VM", + "name": "name", "type": "string" }, + {}, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" } ] @@ -131739,148 +131739,145 @@ "name": "registerVnfTemplate", "params": [ { - "description": "32 or 64 bits support. 64 by default", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "bits", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "the tag for this template.", "length": 255, - "name": "isfeatured", + "name": "templatetag", "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": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "the name of the template", "length": 255, - "name": "templatetype", - "required": false, - "since": "4.19.0", + "name": "name", + "required": true, "type": "string" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "ispublic", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "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": "32 or 64 bits support. 64 by default", "length": 255, - "name": "ostypeid", - "related": "", + "name": "bits", "required": false, - "type": "uuid" + "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", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "vnfdetails", + "name": "ispublic", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "true if this template requires HVM", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "requireshvm", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "isdynamicallyscalable", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "the tag for this template.", + "description": "the target hypervisor for the template", "length": 255, - "name": "templatetag", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "isfeatured", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", + "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 type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "account", + "name": "templatetype", "required": false, + "since": "4.19.0", "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. ", + "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": "zoneids", - "related": "listZones", + "name": "vnfdetails", "required": false, - "type": "list" + "type": "map" }, { - "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 CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "checksum", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "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": "sshkeyenabled", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "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": "arch", + "name": "vnfnics", "required": false, - "since": "4.20", - "type": "string" + "type": "map" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", - "length": 255, - "name": "format", - "required": true, + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "sshkeyenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "true if this template requires HVM", "length": 255, - "name": "isextractable", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "isrouting", + "name": "directdownload", "required": false, "type": "boolean" }, @@ -131893,74 +131890,122 @@ "type": "boolean" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "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": "details", + "name": "zoneids", + "related": "listZones", "required": false, - "type": "map" + "type": "list" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "directdownload", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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": "Register template for the project", "length": 255, - "name": "vnfnics", + "name": "projectid", + "related": "", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the target hypervisor for the template", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "hypervisor", + "name": "format", "required": true, "type": "string" }, { - "description": "the name of the template", + "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": "name", - "required": true, + "name": "checksum", + "required": false, "type": "string" }, { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Register template for the project", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "passwordenabled", + "name": "isextractable", "required": false, "type": "boolean" } ], - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, {}, { - "description": "the status of the template", - "name": "status", + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { @@ -131969,33 +132014,48 @@ "type": "integer" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { @@ -132003,19 +132063,70 @@ "name": "ostypename", "type": "string" }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the size of the template", + "name": "size", + "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 project name of the template", "name": "project", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + {}, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { @@ -132024,23 +132135,33 @@ "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { @@ -132049,28 +132170,23 @@ "type": "map" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the template name", - "name": "name", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { @@ -132078,218 +132194,102 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "the domain associated with the tag", - "name": "domain", + "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "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" } ], "type": "set" }, { - "description": "the date this template was created", - "name": "created", + "description": "the date this template was removed", + "name": "removed", "type": "date" }, { - "description": "the name of the secondary storage host for the template", - "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 URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "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", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "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": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "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 physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the template ID", - "name": "id", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { "description": "the account id to which the template belongs", "name": "accountid", "type": "string" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "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: 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": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "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 secondary storage host for the template", - "name": "hostid", - "type": "string" } ], "since": "4.19.0" @@ -132300,69 +132300,151 @@ "name": "listVirtualMachinesUsageHistory", "params": [ { - "description": "the IDs of the virtual machines, mutually exclusive with id.", + "description": "List by keyword", "length": 255, - "name": "ids", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "page", + "name": "startdate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "the ID of the virtual machine.", + "description": "the IDs of the virtual machines, mutually exclusive with id.", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "ids", + "related": "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" + "type": "list" }, { - "description": "List by keyword", + "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": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "startdate", + "name": "page", "required": false, - "type": "date" + "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": "the ID of the virtual machine.", "length": 255, - "name": "name", + "name": "id", + "related": "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": "string" + "type": "uuid" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "enddate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" }, { - "description": "", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "pagesize", + "name": "enddate", "required": false, - "type": "integer" + "type": "date" } ], "related": "listSystemVmsUsageHistory", "response": [ { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the list of VM stats", + "name": "stats", + "response": [ + { + "description": "the VM's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the VM's free memory in KB or -1 if it cannot be gathered", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the time when the VM stats were collected. The format is \"yyyy-MM-dd hh:mm:ss\"", + "name": "timestamp", + "type": "date" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the memory used by the VM in KB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the VM's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", + "name": "diskioread", + "type": "long" + }, + { + "description": "the total disk iops since the last stats retrieval", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "the amount of downloaded data by the VM in MiB", + "name": "networkread", + "type": "string" + }, + { + "description": "the amount of uploaded data by the VM in MiB", + "name": "networkwrite", + "type": "string" + }, + { + "description": "the amount (percentage) of the VM's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the target memory in VM (KB)", + "name": "memorytargetkbs", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, {}, @@ -132372,26 +132454,16 @@ "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "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" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the list of VM stats", - "name": "stats", - "type": "list" - }, - {} + } ], "since": "4.17" }, @@ -132411,14 +132483,100 @@ ], "related": "reconnectHost", "response": [ + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + {}, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the host version", + "name": "version", + "type": "string" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "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": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, { "description": "the date and time the host was created", "name": "created", "type": "date" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { @@ -132432,90 +132590,134 @@ "type": "date" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, { "description": "the outgoing network traffic on the host", "name": "networkkbswrite", "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "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 amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, { "description": "events available for the host", "name": "events", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", + "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 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 cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, - {}, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "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": "CPU Arch of the host", @@ -132523,34 +132725,34 @@ "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "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": "GPU cards present in the host", @@ -132566,13 +132768,8 @@ "name": "vgpu", "response": [ { - "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", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { @@ -132580,6 +132777,11 @@ "name": "videoram", "type": "long" }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, { "description": "Maximum X resolution per display", "name": "maxresolutionx", @@ -132591,14 +132793,14 @@ "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "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": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { "description": "Maximum no. of vgpu per gpu card (pgpu)", @@ -132612,109 +132814,54 @@ "type": "list" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "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 host", - "name": "id", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { "description": "the amount of the host's CPU currently allocated in MHz", "name": "cpuallocatedvalue", "type": "long" }, + {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, - { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { @@ -132723,84 +132870,9 @@ "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 host hypervisor", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "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 state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" - }, - { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" } ], "since": "4.16.0.0" @@ -132810,14 +132882,6 @@ "isasync": true, "name": "createKubernetesCluster", "params": [ - { - "description": "availability zone in which Kubernetes cluster to be launched", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, { "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, @@ -132833,12 +132897,20 @@ "type": "string" }, { - "description": "number of Kubernetes cluster control nodes, default is 1", + "description": "number of Kubernetes cluster worker nodes", "length": 255, - "name": "controlnodes", + "name": "size", "required": false, "type": "long" }, + { + "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": "type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", "length": 255, @@ -132848,33 +132920,33 @@ "type": "string" }, { - "description": "root disk size in GB for each node", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "noderootdisksize", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "user name for the docker image private registry", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "dockerregistryusername", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "description": "name of the ssh key pair used to login to the virtual machines", "length": 255, - "name": "masternodes", + "name": "keypair", "required": false, - "type": "long" + "type": "string" }, { - "description": "name for the Kubernetes cluster", + "description": "number of Kubernetes cluster control nodes, default is 1", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "controlnodes", + "required": false, + "type": "long" }, { "description": "Deploy cluster for the project", @@ -132885,27 +132957,25 @@ "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "externalloadbalanceripaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Network in which Kubernetes cluster is to be launched", + "description": "root disk size in GB for each node", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "noderootdisksize", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "number of Kubernetes cluster worker nodes", + "description": "name for the Kubernetes cluster", "length": 255, - "name": "size", - "required": false, - "type": "long" + "name": "name", + "required": true, + "type": "string" }, { "description": "Kubernetes version with which cluster to be launched", @@ -132916,32 +132986,34 @@ "type": "uuid" }, { - "description": "description for the Kubernetes cluster", + "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", "length": 255, - "name": "description", + "name": "masternodes", "required": false, - "type": "string" + "type": "long" }, { - "description": "name of the ssh key pair used to login to the virtual machines", + "description": "availability zone in which Kubernetes cluster to be launched", "length": 255, - "name": "keypair", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "user name for the docker image private registry", + "description": "description for the Kubernetes cluster", "length": 255, - "name": "dockerregistryusername", + "name": "description", "required": false, "type": "string" }, { - "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "description": "Network in which Kubernetes cluster is to be launched", "length": 255, - "name": "externalloadbalanceripaddress", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "string" + "type": "uuid" }, { "description": "URL for the docker image private registry", @@ -132953,122 +133025,120 @@ ], "related": "startKubernetesCluster", "response": [ - { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" - }, { "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "name": "zoneid", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" }, - {}, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "keypair details", + "name": "keypair", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "path of the domain to which the Kubernetes cluster belongs", "name": "domainpath", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", - "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 template of the Kubernetes cluster", - "name": "templateid", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", + "description": "Maximum size of the cluster", + "name": "maxsize", "type": "long" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, { "description": "the name of the service offering of the Kubernetes cluster", @@ -133076,74 +133146,76 @@ "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, + {}, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "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", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "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" } ] }, @@ -133152,13 +133224,6 @@ "isasync": false, "name": "listStorageNetworkIpRange", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", "length": 255, @@ -133168,19 +133233,26 @@ "type": "uuid" }, { - "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", + "description": "", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "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": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", + "length": 255, + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "required": false, + "type": "uuid" }, { "description": "", @@ -133200,41 +133272,44 @@ ], "related": "createStorageNetworkIpRange", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the gateway of the storage network IP range", "name": "gateway", "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "integer" }, - {}, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -133242,19 +133317,16 @@ "name": "id", "type": "string" }, + {}, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "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": "the start ip of the storage network IP range", + "name": "startip", "type": "string" } ], @@ -133283,37 +133355,28 @@ ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "path of the domain to which the provider belongs", "name": "domainpath", "type": "string" }, - {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the project name of the address", + "name": "project", "type": "string" }, + {}, { - "description": "the domain ID associated with the provider", - "name": "domainid", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { "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": "the id of the router", "name": "id", @@ -133330,16 +133393,25 @@ "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the project id of the ipaddress", + "name": "projectid", "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" + } ] }, { @@ -133358,11 +133430,6 @@ ], "related": "disableHAForHost", "response": [ - { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -133374,11 +133441,16 @@ "name": "jobid", "type": "string" }, + { + "description": "operation status", + "name": "status", + "type": "boolean" + }, {}, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the host HA provider", + "name": "haprovider", + "type": "string" }, { "description": "the ID of the host", @@ -133386,14 +133458,14 @@ "type": "string" }, { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" } ], "since": "4.11" @@ -133403,14 +133475,6 @@ "isasync": true, "name": "updateVMAffinityGroup", "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" - }, { "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, @@ -133419,6 +133483,14 @@ "required": false, "type": "list" }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "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": "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, @@ -133428,170 +133500,120 @@ "type": "list" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "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": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the VM's primary IP address", + "name": "ipaddress", "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": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "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 account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "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 write in KiB", - "name": "diskkbswrite", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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": "Type of adapter if available", - "name": "adaptertype", + "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -133600,19 +133622,19 @@ "type": "boolean" }, { - "description": "the ID of the nic", - "name": "id", + "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", + "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { "description": "device id for the network when plugged into the virtual machine", @@ -133620,38 +133642,33 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "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" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -133660,62 +133677,51 @@ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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": "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the nic", + "name": "id", + "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": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], "type": "set" }, - {}, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "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 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 ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, { - "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 project name of the vm", - "name": "project", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -133723,23 +133729,18 @@ "name": "affinitygroup", "response": [ { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -133748,24 +133749,29 @@ "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 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 ID of the affinity group", - "name": "id", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { "description": "the name of the affinity group", @@ -133773,8 +133779,8 @@ "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { @@ -133786,123 +133792,183 @@ "type": "set" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "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 user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, { "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 host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "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": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, { "description": "true if the password rest feature is enabled, false otherwise", "name": "passwordenabled", "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "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 userdata used for the VM", - "name": "userdataname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "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", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { @@ -133910,115 +133976,222 @@ "name": "securitygroup", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "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 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 list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "account owning the security group rule", + "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" + }, + { + "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "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 description of the security group", + "name": "description", + "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": "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": "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" + }, { "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 account associated with the tag", - "name": "account", + "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": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "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 domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" @@ -134028,23 +134201,13 @@ "name": "projectid", "type": "string" }, - { - "description": "the project name of the group", - "name": "project", - "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 type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -134052,48 +134215,63 @@ "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": "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", + "description": "the domain associated with the tag", + "name": "domain", "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", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "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 name where tag belongs to", + "name": "project", "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 domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -134102,26 +134280,21 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -134130,153 +134303,65 @@ "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 ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" - } - ], - "type": "set" - }, - { - "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 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": "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", + "description": "account owning the security group rule", "name": "account", "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" } ], "type": "set" }, - { - "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 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 ID of the security group", - "name": "id", - "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 name of the security group", - "name": "name", - "type": "string" } ], "type": "set" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, - {}, { - "description": "User VM type", - "name": "vmtype", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "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 project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { "description": "the ID of the virtual machine", @@ -134284,44 +134369,75 @@ "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 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 vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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 service offering of the virtual machine", + "name": "serviceofferingid", + "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, { "description": "the name of the service offering of the virtual machine", "name": "serviceofferingname", "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "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 ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { "description": "path of the domain in which the virtual machine exists", @@ -134329,23 +134445,28 @@ "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { @@ -134358,23 +134479,23 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -134383,67 +134504,41 @@ "type": "string" }, { - "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": "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - {}, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { @@ -134452,75 +134547,52 @@ "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "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 network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "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 userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "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", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - } + {} ] }, { @@ -134545,11 +134617,23 @@ ], "related": "listRegisteredServicePackages", "response": [ + { + "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": "Service Package UUID", + "name": "id", + "type": "string" + }, + {}, { "description": "Service Package Name", "name": "name", @@ -134559,19 +134643,7 @@ "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": "Description of Service Package", - "name": "description", - "type": "string" - }, - {}, - {} + } ] }, { @@ -134587,11 +134659,11 @@ "type": "string" }, { - "description": "If set to true then SSL verification will be done for the Webhook otherwise not", + "description": "State of the Webhook", "length": 255, - "name": "sslverification", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { "description": "The ID of the Webhook", @@ -134602,64 +134674,64 @@ "type": "uuid" }, { - "description": "State of the Webhook", + "description": "If set to true then SSL verification will be done for the Webhook otherwise not", "length": 255, - "name": "state", + "name": "sslverification", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Description for the Webhook", + "description": "Secret key of the Webhook", "length": 255, - "name": "description", + "name": "secretkey", "required": false, "type": "string" }, { - "description": "Name for the Webhook", + "description": "Description for the Webhook", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" }, { - "description": "Secret key of the Webhook", + "description": "Scope of the Webhook", "length": 255, - "name": "secretkey", + "name": "scope", "required": false, "type": "string" }, { - "description": "Scope of the Webhook", + "description": "Name for the Webhook", "length": 255, - "name": "scope", + "name": "name", "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": "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.20.0" }, @@ -134669,19 +134741,11 @@ "name": "quotaCredits", "params": [ { - "description": "Domain for which quota credits need to be added", + "description": "Value of the credits to be added+, subtracted-", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "value", "required": true, - "type": "uuid" - }, - { - "description": "Account for which quota enforce is set to false will not be locked when there is no credit balance", - "length": 255, - "name": "quota_enforce", - "required": false, - "type": "boolean" + "type": "double" }, { "description": "Account Id for which quota credits need to be added", @@ -134691,11 +134755,19 @@ "type": "string" }, { - "description": "Value of the credits to be added+, subtracted-", + "description": "Domain for which quota credits need to be added", "length": 255, - "name": "value", + "name": "domainid", + "related": "listDomains", "required": true, - "type": "double" + "type": "uuid" + }, + { + "description": "Account for which quota enforce is set to false will not be locked when there is no credit balance", + "length": 255, + "name": "quota_enforce", + "required": false, + "type": "boolean" }, { "description": "Minimum balance threshold of the account", @@ -134707,37 +134779,37 @@ ], "related": "", "response": [ - { - "description": "the credit deposited", - "name": "credits", - "type": "bigdecimal" - }, - { - "description": "currency", - "name": "currency", - "type": "string" - }, { "description": "the account name of the admin who updated the credits", "name": "updated_on", "type": "date" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the credit deposited", + "name": "credits", + "type": "bigdecimal" + }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the user name of the admin who updated the credits", "name": "updated_by", "type": "string" + }, + { + "description": "currency", + "name": "currency", + "type": "string" } ], "since": "4.7.0" @@ -134758,32 +134830,32 @@ "related": "", "response": [ { - "description": "Private key for the certificate", - "name": "privatekey", + "description": "The CA certificate(s)", + "name": "cacertificates", "type": "string" }, - {}, { "description": "The client certificate", "name": "certificate", "type": "string" }, + {}, { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "Private key for the certificate", + "name": "privatekey", + "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" - } + {} ], "since": "4.11.0" }, @@ -134793,43 +134865,44 @@ "name": "provisionTemplateDirectDownloadCertificate", "params": [ { - "description": "the id of the direct download certificate to provision", + "description": "the host to provision the certificate", "length": 255, - "name": "id", - "related": "", + "name": "hostid", + "related": "reconnectHost", "required": true, "type": "uuid" }, { - "description": "the host to provision the certificate", + "description": "the id of the direct download certificate to provision", "length": 255, - "name": "hostid", - "related": "reconnectHost", + "name": "id", + "related": "", "required": true, "type": "uuid" } ], "related": "", "response": [ + {}, + {}, { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { @@ -134838,11 +134911,10 @@ "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.17.0" }, @@ -134859,6 +134931,13 @@ "required": true, "type": "uuid" }, + { + "description": "The description of the Project role", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, { "description": "creates a project role with this unique name", "length": 255, @@ -134873,41 +134952,35 @@ "related": "updateProjectRole", "required": true, "type": "uuid" - }, - { - "description": "The description of the Project role", - "length": 255, - "name": "description", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "the ID of the role", "name": "id", "type": "string" }, + {}, { - "description": "the description of the role", - "name": "description", + "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 role", - "name": "name", + "description": "the description of the role", + "name": "description", "type": "string" }, { @@ -134915,7 +134988,6 @@ "name": "projectid", "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", @@ -134929,6 +135001,13 @@ "isasync": false, "name": "addLdapConfiguration", "params": [ + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" + }, { "description": "linked domain", "length": 255, @@ -134943,18 +135022,10 @@ "name": "port", "required": true, "type": "integer" - }, - { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" } ], "related": "", "response": [ - {}, { "description": "name of the host running the ldap server", "name": "hostname", @@ -134966,6 +135037,12 @@ "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "linked domain", "name": "domainid", @@ -134975,11 +135052,6 @@ "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", - "type": "string" } ], "since": "4.2.0" @@ -134990,11 +135062,12 @@ "name": "createTungstenFabricAddressGroup", "params": [ { - "description": "Tungsten-Fabric ip prefix length", + "description": "the ID of zone", "length": 255, - "name": "ipprefixlen", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "integer" + "type": "uuid" }, { "description": "Tungsten-Fabric address group name", @@ -135011,36 +135084,33 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric ip prefix length", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "ipprefixlen", "required": true, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ + { + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Tungsten-Fabric address group name", - "name": "name", - "type": "string" - }, - {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric address group name", + "name": "name", "type": "string" }, { @@ -135048,19 +135118,21 @@ "name": "ipprefix", "type": "string" }, + {}, { - "description": "Tungsten-Fabric address group ip prefix length", - "name": "ipprefixlen", - "type": "int" + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", + "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 address group uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" } ] @@ -135070,13 +135142,6 @@ "isasync": false, "name": "listBigSwitchBcfDevices", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -135085,10 +135150,10 @@ "type": "string" }, { - "description": "bigswitch BCF controller device ID", + "description": "the Physical Network ID", "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", + "name": "physicalnetworkid", + "related": "", "required": false, "type": "uuid" }, @@ -135100,36 +135165,42 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "bigswitch BCF controller device ID", + "length": 255, + "name": "bcfdeviceid", + "related": "listBigSwitchBcfDevices", "required": false, "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "device name", - "name": "bigswitchdevicename", + "description": "the controller username", + "name": "username", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "NAT support", - "name": "nat", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" }, { @@ -135138,19 +135209,20 @@ "type": "string" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, { - "description": "the controller username", - "name": "username", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "NAT support", + "name": "nat", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -135171,11 +135243,11 @@ "name": "listRegisteredServicePackages", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -135185,40 +135257,40 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - { - "description": "Service Package UUID", - "name": "id", - "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": "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 Name", - "name": "name", + "description": "Service Package UUID", + "name": "id", + "type": "string" + }, + {}, + { + "description": "Description of Service Package", + "name": "description", "type": "string" } ] @@ -135229,20 +135301,12 @@ "name": "changeSharedFileSystemDiskOffering", "params": [ { - "description": "the size of the shared filesystem in GiB", + "description": "min iops", "length": 255, - "name": "size", + "name": "miniops", "required": false, "type": "long" }, - { - "description": "the disk offering to use for the underlying storage", - "length": 255, - "name": "diskofferingid", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "the ID of the shared filesystem", "length": 255, @@ -135252,16 +135316,24 @@ "type": "uuid" }, { - "description": "max iops", + "description": "the size of the shared filesystem in GiB", "length": 255, - "name": "maxiops", + "name": "size", "required": false, "type": "long" }, { - "description": "min iops", + "description": "the disk offering to use for the underlying storage", "length": 255, - "name": "miniops", + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "max iops", + "length": 255, + "name": "maxiops", "required": false, "type": "long" } @@ -135269,49 +135341,43 @@ "related": "", "response": [ { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, - {}, { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { @@ -135320,67 +135386,33 @@ "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": "virtualmachineid", - "type": "string" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - }, - { - "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": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, + {}, { - "description": "description of the shared filesystem", - "name": "description", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { "description": "the list of resource tags associated", "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -135389,13 +135421,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "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" }, { @@ -135409,13 +135441,23 @@ "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": "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" }, { @@ -135427,68 +135469,99 @@ "type": "set" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the filesystem format", + "name": "filesystem", + "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "size of the shared filesystem", + "name": "size", "type": "long" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + {}, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { @@ -135496,38 +135569,38 @@ "name": "nic", "response": [ { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "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 ID of the nic", - "name": "id", + "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", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -135536,53 +135609,43 @@ "type": "boolean" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "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", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -135591,28 +135654,33 @@ "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "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": "the type of the nic", - "name": "type", + "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": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -135620,88 +135688,92 @@ "name": "extradhcpoption", "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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": "the IPv6 address of network", - "name": "ip6address", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" } ], "type": "list" }, { - "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", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" + "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", + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" } ], @@ -135716,10 +135788,17 @@ "description": "the ID of the virtual machine for enabling static NAT feature", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "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": "VM guest NIC secondary IP address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, + "type": "string" + }, { "description": "the public IP address ID for which static NAT feature is being enabled", "length": 255, @@ -135735,38 +135814,31 @@ "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" - }, - { - "description": "VM guest NIC secondary IP address for the port forwarding rule", - "length": 255, - "name": "vmguestip", - "required": false, - "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": "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" - }, - {} + } ] }, { @@ -135784,22 +135856,22 @@ } ], "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": "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", @@ -135823,27 +135895,27 @@ } ], "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.20.0" @@ -135860,27 +135932,6 @@ "required": false, "type": "integer" }, - { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, - "type": "string" - }, - { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" - }, - { - "description": "true if the template is available to all accounts; default is true", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, { "description": "Upload volume/template/iso for the project", "length": 255, @@ -135890,20 +135941,27 @@ "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 tag for this template.", "length": 255, - "name": "ostypeid", - "related": "", + "name": "templatetag", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "passwordenabled", + "name": "isextractable", "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": "the display text of the template. This is usually used for display purposes.", "length": 4096, @@ -135912,41 +135970,33 @@ "type": "string" }, { - "description": "the tag for this template.", + "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": "templatetag", + "name": "ostypeid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the volume/template/iso", + "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": "name", - "required": true, + "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" - }, - { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "deployasis", + "name": "isrouting", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "description": "Template details in key/value pairs.", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "details", + "name": "sshkeyenabled", "required": false, - "type": "map" + "type": "boolean" }, { "description": "true if this template is a featured template, false otherwise", @@ -135956,38 +136006,52 @@ "type": "boolean" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" + "name": "format", + "required": true, + "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "the target hypervisor for the template", "length": 255, - "name": "account", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the target hypervisor for the template", + "description": "the name of the volume/template/iso", "length": 255, - "name": "hypervisor", + "name": "name", "required": true, "type": "string" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "arch", + "name": "ispublic", "required": false, - "since": "4.20", - "type": "string" + "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "Template details in key/value pairs.", "length": 255, - "name": "isdynamicallyscalable", + "name": "details", + "required": false, + "type": "map" + }, + { + "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": "true if the template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", "required": false, "type": "boolean" }, @@ -135998,6 +136062,14 @@ "required": false, "type": "boolean" }, + { + "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": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, @@ -136007,16 +136079,16 @@ "type": "uuid" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "isrouting", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "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": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "checksum", + "name": "account", "required": false, "type": "string" } @@ -136024,18 +136096,13 @@ "related": "getUploadParamsForIso", "response": [ { - "description": "the timestamp after which the signature expires", - "name": "expires", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" }, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" }, { @@ -136044,20 +136111,25 @@ "type": "url" }, {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "the timestamp after which the signature expires", + "name": "expires", + "type": "string" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -136086,27 +136158,27 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "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" + }, {} ] }, @@ -136123,18 +136195,18 @@ "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -136147,14 +136219,13 @@ "related": "", "response": [ { - "description": "network traffic type", - "name": "traffictype", - "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": "network traffic type", + "name": "traffictype", "type": "string" }, { @@ -136163,10 +136234,11 @@ "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" @@ -136179,14 +136251,14 @@ "related": "", "response": [ { - "description": "the number of queries performed on the DB", - "name": "queries", - "type": "long" + "description": "the state of the usage server", + "name": "replicas", + "type": "string[]" }, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" + "description": "the tls versions currently in use (accepted) by the DB", + "name": "tlsversions", + "type": "string" }, { "description": "the name of the active usage server", @@ -136194,31 +136266,36 @@ "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, + { + "description": "the last measured load averages on the DB", + "name": "dbloadaverages", + "type": "double[]" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the uptime of the DB in seconds", + "name": "uptime", + "type": "long" + }, { "description": "the number of connections to the DB", "name": "connections", "type": "int" }, { - "description": "the version of the currently running DB", - "name": "versioncomment", - "type": "string" - }, - { - "description": "the tls versions currently in use (accepted) by the DB", - "name": "tlsversions", - "type": "string" - }, - { - "description": "the state of the usage server", - "name": "replicas", - "type": "string[]" + "description": "the number of queries performed on the DB", + "name": "queries", + "type": "long" }, { "description": "the version of the currently running DB", @@ -136226,19 +136303,14 @@ "type": "string" }, { - "description": "the uptime of the DB in seconds", - "name": "uptime", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { - "description": "the last measured load averages on the DB", - "name": "dbloadaverages", - "type": "double[]" + "description": "the version of the currently running DB", + "name": "versioncomment", + "type": "string" } ], "since": "4.17.0" @@ -136258,23 +136330,23 @@ } ], "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 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", @@ -136289,19 +136361,20 @@ "name": "listAutoScaleVmProfiles", "params": [ { - "description": "the templateid of the autoscale vm profile", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the autoscale vm profile", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listAutoScaleVmProfiles", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -136311,72 +136384,72 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "list profiles by service offering id", "length": 255, - "name": "keyword", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "string" + "since": "4.4", + "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 autoscale vm profile", + "description": "", "length": 255, - "name": "id", - "related": "listAutoScaleVmProfiles", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "projectid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "the otherdeployparameters of the autoscale vm profile", + "description": "List by keyword", "length": 255, - "name": "otherdeployparams", + "name": "keyword", "required": false, "type": "string" }, { - "description": "availability zone for the auto deployed virtual machine", + "description": "the otherdeployparameters of the autoscale vm profile", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "otherdeployparams", "required": false, - "since": "4.4", - "type": "uuid" + "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": "list profiles by service offering id", + "description": "the templateid of the autoscale vm profile", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "since": "4.4", "type": "uuid" }, { @@ -136388,36 +136461,25 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain 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": "domainid", - "related": "listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "", "response": [ { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" - }, - { - "description": "path of the domain to which the vm profile belongs", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, - { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -136428,26 +136490,29 @@ "name": "templateid", "type": "string" }, - {}, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" + }, + { + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { @@ -136455,31 +136520,42 @@ "name": "zoneid", "type": "string" }, + { + "description": "the project name of the vm profile", + "name": "project", + "type": "string" + }, { "description": "is profile 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": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, {}, + { + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", + "type": "string" + }, { "description": "the domain name of the vm profile", "name": "domain", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, - {}, { - "description": "Base64 encoded VM user data", - "name": "userdata", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { @@ -136488,25 +136564,21 @@ "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, - { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - } + {} ] }, { @@ -136515,128 +136587,122 @@ "name": "authorizeSecurityGroupIngress", "params": [ { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "securitygroupname", + "name": "account", "required": false, "type": "string" }, { - "description": "error code for this icmp message", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "icmpcode", + "name": "securitygroupid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "account", + "name": "securitygroupname", "required": false, "type": "string" }, { - "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": "an optional project of the security group", "length": 255, - "name": "protocol", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "description": "error code for this icmp message", "length": 255, - "name": "cidrlist", + "name": "icmpcode", "required": false, - "type": "list" + "type": "integer" }, { - "description": "end port for this ingress rule", + "description": "user to security group mapping", "length": 255, - "name": "endport", + "name": "usersecuritygrouplist", "required": false, - "type": "integer" + "type": "map" }, { - "description": "type of the icmp message being sent", + "description": "end port for this ingress rule", "length": 255, - "name": "icmptype", + "name": "endport", "required": false, "type": "integer" }, { - "description": "start port for this ingress rule", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "startport", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "an optional project of the security group", + "description": "type of the icmp message being sent", "length": 255, - "name": "projectid", - "related": "", + "name": "icmptype", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "user to security group mapping", + "description": "start port for this ingress rule", "length": 255, - "name": "usersecuritygrouplist", + "name": "startport", "required": false, - "type": "map" + "type": "integer" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "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": "domainid", - "related": "listDomains", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "securitygroupid", - "related": "", + "name": "cidrlist", "required": false, - "type": "uuid" + "type": "list" } ], "related": "", "response": [ - {}, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "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" }, { @@ -136645,84 +136711,90 @@ "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" }, { - "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "tag key name", - "name": "key", + "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", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "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", + "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", + "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", + "type": "integer" + }, + {} ] }, { @@ -136742,166 +136814,166 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the storage pool path", - "name": "path", + "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 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": "the Pod ID of the storage pool", - "name": "podid", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "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 storage pool path", + "name": "path", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "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 storage pool type", - "name": "type", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, { "description": "the tags for the storage pool", "name": "tags", "type": "string" }, - { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, { "description": "Whether the informed tag is a JS interpretable rule or not.", "name": "istagarule", "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, + {}, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, - { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" - }, { "description": "the scope of the storage pool", "name": "scope", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "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 ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, - {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.15.1" @@ -136912,9 +136984,9 @@ "name": "updateBucket", "params": [ { - "description": "Enable/Disable Bucket encryption", + "description": "Enable/Disable Bucket Versioning", "length": 255, - "name": "encryption", + "name": "versioning", "required": false, "type": "boolean" }, @@ -136941,36 +137013,36 @@ "type": "string" }, { - "description": "Enable/Disable Bucket Versioning", + "description": "Enable/Disable Bucket encryption", "length": 255, - "name": "versioning", + "name": "encryption", "required": false, "type": "boolean" } ], "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.19.0" }, @@ -136988,11 +137060,10 @@ "type": "uuid" }, { - "description": "Tag for the resource type", + "description": "Update resource count for a specified account. Must be used with the domainId parameter.", "length": 255, - "name": "tag", + "name": "account", "required": false, - "since": "4.20.0", "type": "string" }, { @@ -137011,19 +137082,21 @@ "type": "integer" }, { - "description": "Update resource count for a specified account. Must be used with the domainId parameter.", + "description": "Tag for the resource type", "length": 255, - "name": "account", + "name": "tag", "required": false, + "since": "4.20.0", "type": "string" } ], "related": "", "response": [ + {}, { - "description": "The resource count", - "name": "resourcecount", - "type": "long" + "description": "the domain name for which resource count's are updated", + "name": "domain", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -137031,18 +137104,23 @@ "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", + "description": "Tag for the resource", + "name": "tag", "type": "string" }, { - "description": "the account for which resource count's are updated", - "name": "account", + "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": "Tag for the resource", - "name": "tag", + "description": "the domain ID for which resource count's are updated", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the domain to which the resource counts are updated", + "name": "domainpath", "type": "string" }, { @@ -137050,16 +137128,19 @@ "name": "jobid", "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": "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": "path of the domain to which the resource counts are updated", - "name": "domainpath", + "description": "The resource count", + "name": "resourcecount", + "type": "long" + }, + { + "description": "the account for which resource count's are updated", + "name": "account", "type": "string" }, { @@ -137072,16 +137153,7 @@ "name": "project", "type": "string" }, - { - "description": "the domain name for which resource count's are updated", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID for which resource count's are updated", - "name": "domainid", - "type": "string" - } + {} ] }, { @@ -137090,23 +137162,23 @@ "name": "listRoles", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List role by role name.", + "description": "List role by role type status, valid options are: enabled, disabled", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" }, @@ -137118,76 +137190,76 @@ "type": "integer" }, { - "description": "List role by role type status, valid options are: enabled, disabled", + "description": "List role by role name.", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, { - "description": "List role by role ID.", + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", "length": 255, - "name": "id", - "related": "listRoles", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List role by role ID.", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listRoles", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the name of the role", - "name": "name", + "description": "the state of the role", + "name": "state", "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", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the description of the role", + "name": "description", + "type": "string" }, {}, { - "description": "the type of the role", - "name": "type", + "description": "the ID of the role", + "name": "id", "type": "string" }, + {}, { - "description": "the state of the role", - "name": "state", + "description": "the name of the role", + "name": "name", "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 description of the role", - "name": "description", + "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 role is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], "since": "4.9.0" @@ -137213,61 +137285,54 @@ "type": "uuid" }, { - "description": "the ID of ip address", + "description": "the ID of zone", "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of ip address", "length": 255, - "name": "keyword", + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ - { - "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 provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -137275,10 +137340,18 @@ "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "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": "list Tungsten-Fabric policy network name", "name": "network", @@ -137288,8 +137361,7 @@ "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" - }, - {} + } ] }, { @@ -137297,13 +137369,6 @@ "isasync": true, "name": "downloadImageStoreObject", "params": [ - { - "description": "path to download on image store", - "length": 255, - "name": "path", - "required": false, - "type": "string" - }, { "description": "id of the image store", "length": 255, @@ -137311,25 +137376,39 @@ "related": "listSwifts", "required": true, "type": "uuid" + }, + { + "description": "path to download on image store", + "length": 255, + "name": "path", + "required": false, + "type": "string" } ], "related": "extractSnapshot,extractTemplate", "response": [ + {}, { - "description": "the id of extracted object", - "name": "id", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the status of the extraction", + "name": "status", + "type": "string" + }, + { + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, + {}, { "description": "the time and date the object was created", "name": "created", @@ -137341,62 +137420,55 @@ "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "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", + "description": "type of the storage", + "name": "storagetype", "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": "zone name the object was extracted from", - "name": "zonename", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", - "type": "string" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, - {}, { - "description": "the status of the extraction", - "name": "status", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "the name of the extracted object", - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" - }, - {} + } ], "since": "4.19.0" }, @@ -137422,14 +137494,15 @@ "type": "string" }, {}, + {}, { - "description": "the signed response for the cloud identifier", - "name": "signature", + "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 cloud identifier", + "name": "cloudidentifier", "type": "string" }, { @@ -137437,10 +137510,9 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the cloud identifier", - "name": "cloudidentifier", + "description": "the signed response for the cloud identifier", + "name": "signature", "type": "string" } ] @@ -137450,13 +137522,6 @@ "isasync": true, "name": "createLBStickinessPolicy", "params": [ - { - "description": "name of the load balancer stickiness policy", - "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, @@ -137465,13 +137530,6 @@ "since": "4.4", "type": "boolean" }, - { - "description": "the description of the load balancer stickiness policy", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "the ID of the load balancer rule", "length": 255, @@ -137487,6 +137545,20 @@ "required": true, "type": "string" }, + { + "description": "name of the load balancer stickiness policy", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the description of the load balancer stickiness policy", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, { "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", "length": 255, @@ -137498,23 +137570,18 @@ "related": "", "response": [ { - "description": "the description of the Stickiness policy", - "name": "description", + "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 LB rule ID", - "name": "lbruleid", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { @@ -137523,31 +137590,41 @@ "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "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" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, + {}, { "description": "the name of the Stickiness policy", "name": "name", "type": "string" }, - {}, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the method name of the Stickiness policy", "name": "methodname", @@ -137559,36 +137636,31 @@ "type": "map" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "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", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" } ], "type": "list" }, { - "description": "the state of the policy", - "name": "state", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" } ], @@ -137599,14 +137671,6 @@ "isasync": false, "name": "addCiscoAsa1000vResource", "params": [ - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", "length": 255, @@ -137628,16 +137692,18 @@ "name": "insideportprofile", "required": true, "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, {}, {}, @@ -137648,6 +137714,12 @@ }, {}, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {} ] }, @@ -137656,13 +137728,6 @@ "isasync": true, "name": "configurePaloAltoFirewall", "params": [ - { - "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", - "length": 255, - "name": "fwdevicecapacity", - "required": false, - "type": "long" - }, { "description": "Palo Alto firewall device ID", "length": 255, @@ -137670,18 +137735,20 @@ "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", "required": true, "type": "uuid" + }, + { + "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", + "length": 255, + "name": "fwdevicecapacity", + "required": false, + "type": "long" } ], "related": "listPaloAltoFirewalls", "response": [ { - "description": "the public interface of the external firewall", - "name": "publicinterface", - "type": "string" - }, - { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { @@ -137690,25 +137757,24 @@ "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, - {}, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the management IP address of the external firewall", @@ -137716,56 +137782,62 @@ "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "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": "the number of times to retry requests to the external firewall", - "name": "numretries", + "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": "device capacity", "name": "fwdevicecapacity", "type": "long" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, - {}, { "description": "name of the provider", "name": "provider", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "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 usage interface of the external firewall", + "name": "usageinterface", + "type": "string" + }, + {} ] }, { @@ -137782,23 +137854,16 @@ "type": "string" }, { - "description": "the ending port of ACL", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, - { - "description": "type of the ICMP message being sent", + "description": "error code for this ICMP message", "length": 255, - "name": "icmptype", + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "scl entry action, allow or deny", + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "action", + "name": "traffictype", "required": false, "type": "string" }, @@ -137810,47 +137875,40 @@ "type": "list" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "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": "fordisplay", + "name": "partialupgrade", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", - "length": 255, - "name": "protocol", - "required": false, - "type": "string" - }, - { - "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": "The network of the vm the ACL will be created for", "length": 255, - "name": "partialupgrade", + "name": "number", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "type of the ICMP message being sent", "length": 255, - "name": "traffictype", + "name": "icmptype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "error code for this ICMP message", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "icmpcode", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "The network of the vm the ACL will be created for", + "description": "scl entry action, allow or deny", "length": 255, - "name": "number", + "name": "action", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the network ACL item", @@ -137861,9 +137919,9 @@ "type": "uuid" }, { - "description": "the starting port of ACL", + "description": "the ending port of ACL", "length": 255, - "name": "startport", + "name": "endport", "required": false, "type": "integer" }, @@ -137873,13 +137931,37 @@ "name": "reason", "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": false, + "type": "string" + }, + { + "description": "the starting port of ACL", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" } ], "related": "moveNetworkAclItem", "response": [ { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -137887,23 +137969,23 @@ "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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 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", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -137912,72 +137994,66 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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": "resource type", - "name": "resourcetype", + "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, - {}, - { - "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 ID of the ACL Item", + "name": "id", + "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { @@ -137986,45 +138062,41 @@ "type": "integer" }, { - "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 ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - { - "description": "the name of the ACL this item belongs to", - "name": "aclname", - "type": "string" - }, { "description": "is rule for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the ID of the ACL Item", - "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 protocol of the ACL", + "name": "protocol", "type": "string" }, {}, + {}, { - "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": "Action of ACL Item. Allow/Deny", "name": "action", "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -138034,88 +138106,88 @@ "name": "listRouters", "params": [ { - "description": "the Zone ID of the router", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the host ID 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": "hostid", - "related": "reconnectHost", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "if this parameter is passed, list only routers by health check results", + "description": "list virtual router elements by version", "length": 255, - "name": "healthchecksfailed", + "name": "version", "required": false, - "since": "4.16", - "type": "boolean" + "type": "string" }, { - "description": "list by network id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "description": "List networks by VPC", "length": 255, - "name": "fetchhealthcheckresults", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, - "since": "4.14", - "type": "boolean" + "type": "uuid" }, { - "description": "List networks by VPC", + "description": "the Zone ID of the router", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "the state of the router", + "description": "the ID of the disk router", "length": 255, - "name": "state", + "name": "id", + "related": "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" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the host ID of the router", "length": 255, - "name": "account", + "name": "hostid", + "related": "reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the Pod ID of the router", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the name of the router", + "description": "if true is passed for this parameter, list only VPC routers", "length": 255, - "name": "name", + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { "description": "List by keyword", @@ -138125,228 +138197,153 @@ "type": "string" }, { - "description": "the ID of the disk router", + "description": "the name of the router", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list virtual router elements by version", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "version", + "name": "account", "required": false, "type": "string" }, { - "description": "if true is passed for this parameter, list only VPC routers", + "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", "length": 255, - "name": "forvpc", + "name": "fetchhealthcheckresults", "required": false, + "since": "4.14", "type": "boolean" }, { - "description": "", + "description": "if this parameter is passed, list only routers by health check results", "length": 255, - "name": "page", + "name": "healthchecksfailed", "required": false, - "type": "integer" + "since": "4.16", + "type": "boolean" }, { - "description": "the cluster 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": "clusterid", - "related": "addCluster", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "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": "the state of the router", "length": 255, - "name": "listall", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "the cluster ID of the router", "length": 255, - "name": "pagesize", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the Pod ID of the router", + "description": "list by network id", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" } ], "related": "", "response": [ - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, { "description": "the account associated with the router", "name": "account", "type": "string" }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "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", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, {}, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "path of the Domain the router belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "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": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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": "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -138355,73 +138352,68 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the IPv6 address of network", + "name": "ip6address", "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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": "the gateway of the nic", - "name": "gateway", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "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", + "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 vpc to which the nic belongs", "name": "vpcid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -138430,101 +138422,102 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" } ], "type": "set" }, + {}, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "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 router", - "name": "domainid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "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 domain ID associated with the router", + "name": "domainid", + "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the id of the router", + "name": "id", + "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -138533,59 +138526,63 @@ "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "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", + "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 second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" }, { - "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 public IP address for the router", - "name": "publicip", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -138594,34 +138591,44 @@ "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "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 Pod name for the router", + "name": "podname", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the host ID for the router", + "name": "hostid", "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": "Last executed health check result for the router", @@ -138633,32 +138640,97 @@ "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 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" } ], "type": "list" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "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 project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" } ] }, @@ -138675,18 +138747,18 @@ "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -138706,37 +138778,37 @@ ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric vm name", - "name": "name", - "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", + "type": "string" + }, { "description": "Tungsten-Fabric nic uuid", "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric vm name", + "name": "name", "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -138755,28 +138827,28 @@ } ], "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": "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" }, @@ -138786,51 +138858,52 @@ "name": "addTungstenFabricPolicyRule", "params": [ { - "description": "Tungsten-Fabric policy rule source end port", + "description": "Tungsten-Fabric policy rule destination ip prefix", "length": 255, - "name": "srcendport", + "name": "destipprefix", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule source start port", + "description": "Tungsten-Fabric policy rule destination end port", "length": 255, - "name": "srcstartport", + "name": "destendport", "required": true, "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix", + "description": "the ID of zone", "length": 255, - "name": "destipprefix", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "Tungsten-Fabric policy rule destination ip prefix length", "length": 255, - "name": "policyuuid", + "name": "destipprefixlen", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule protocol", + "description": "Tungsten-Fabric policy rule source start port", "length": 255, - "name": "protocol", + "name": "srcstartport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination end port", + "description": "Tungsten-Fabric policy rule source end port", "length": 255, - "name": "destendport", + "name": "srcendport", "required": true, "type": "integer" }, { - "description": "Tungsten-Fabric policy rule source network", + "description": "Tungsten-Fabric policy rule action", "length": 255, - "name": "srcnetwork", + "name": "action", "required": true, "type": "string" }, @@ -138849,45 +138922,44 @@ "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix length", + "description": "Tungsten-Fabric policy rule source ip prefix", "length": 255, - "name": "destipprefixlen", + "name": "srcipprefix", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination start port", + "description": "Tungsten-Fabric policy rule direction", "length": 255, - "name": "deststartport", + "name": "direction", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule direction", + "description": "Tungsten-Fabric policy rule protocol", "length": 255, - "name": "direction", + "name": "protocol", "required": true, "type": "string" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric policy rule source network", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "srcnetwork", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule source ip prefix", + "description": "Tungsten-Fabric policy rule destination start port", "length": 255, - "name": "srcipprefix", + "name": "deststartport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule action", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "action", + "name": "policyuuid", "required": true, "type": "string" } @@ -138895,60 +138967,56 @@ "related": "", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric policy name", + "name": "direction", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", - "type": "int" + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", + "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", - "type": "int" + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", + "type": "string" }, { "description": "Tungsten-Fabric rule uuid", "name": "uuid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", "type": "int" }, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", + "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 policy destination end port", + "name": "destendport", + "type": "int" }, { "description": "Tungsten-Fabric policy action", @@ -138956,41 +139024,45 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", - "type": "string" + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" }, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", "type": "int" }, { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", - "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 destination ip prefix length", + "name": "destipprefixlen", + "type": "int" }, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", "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", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" - }, - {} + } ] }, { @@ -139006,33 +139078,31 @@ "type": "boolean" }, { - "description": "Project for the Webhook", + "description": "State of the Webhook", "length": 255, - "name": "projectid", - "related": "", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Description for the Webhook", + "description": "An optional account for the Webhook. Must be used with domainId.", "length": 255, - "name": "description", + "name": "account", "required": false, "type": "string" }, { - "description": "an optional domainId for the Webhook. If the account parameter is used, domainId must also be used.", + "description": "Description for the Webhook", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "An optional account for the Webhook. Must be used with domainId.", + "description": "Payload URL of the Webhook", "length": 255, - "name": "account", - "required": false, + "name": "payloadurl", + "required": true, "type": "string" }, { @@ -139043,23 +139113,25 @@ "type": "string" }, { - "description": "Scope of the Webhook", + "description": "an optional domainId for the Webhook. 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": "Payload URL of the Webhook", + "description": "Project for the Webhook", "length": 255, - "name": "payloadurl", - "required": true, - "type": "string" + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "State of the Webhook", + "description": "Scope of the Webhook", "length": 255, - "name": "state", + "name": "scope", "required": false, "type": "string" }, @@ -139079,29 +139151,29 @@ "type": "string" }, { - "description": "The name of the domain in which the Webhook exists", - "name": "domain", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "The name of the Webhook", - "name": "name", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "The account associated with the Webhook", - "name": "account", - "type": "string" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, { - "description": "The description of the Webhook", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "The state of the Webhook", @@ -139114,52 +139186,52 @@ "type": "string" }, { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The secret key for the Webhook", + "name": "secretkey", + "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "The name of the Webhook", + "name": "name", "type": "string" }, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "The secret key for the Webhook", - "name": "secretkey", - "type": "string" - }, {}, { "description": "The scope of the Webhook", "name": "scope", "type": "string" }, + {}, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", + "type": "string" }, - {} + { + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" + } ], "since": "4.20.0" }, @@ -139168,6 +139240,13 @@ "isasync": true, "name": "removeVpnUser", "params": [ + { + "description": "an optional account for the vpn user. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, @@ -139183,13 +139262,6 @@ "required": true, "type": "string" }, - { - "description": "an optional account for the vpn user. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "remove vpn user from the project", "length": 255, @@ -139206,7 +139278,6 @@ "name": "jobid", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -139221,7 +139292,8 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -139230,18 +139302,18 @@ "name": "listQuarantinedIps", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Show IPs removed from quarantine.", + "description": "", "length": 255, - "name": "showremoved", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "Show IPs that are no longer in quarantine.", @@ -139251,18 +139323,18 @@ "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "Show IPs removed from quarantine.", "length": 255, - "name": "page", + "name": "showremoved", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "updateQuarantinedIp", @@ -139272,41 +139344,35 @@ "name": "created", "type": "date" }, - { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", - "type": "string" - }, - {}, { "description": "ID of the quarantine process.", "name": "id", "type": "string" }, - { - "description": "When the quarantine 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 account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -139315,15 +139381,21 @@ "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" - } + }, + { + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", + "type": "string" + }, + {} ], "since": "4.19" }, @@ -139353,75 +139425,19 @@ "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.2.0" - }, - { - "description": "Disables HA for a host", - "isasync": true, - "name": "disableHAForHost", - "params": [ - { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, - { - "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", - "type": "string" }, {}, { - "description": "operation status", - "name": "status", + "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 host HA provider", - "name": "haprovider", - "type": "string" } ], - "since": "4.11" + "since": "4.2.0" }, { "description": "List Swift.", @@ -139435,6 +139451,13 @@ "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -139448,62 +139471,56 @@ "name": "id", "required": false, "type": "long" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "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" }, {}, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, + {}, { "description": "the name of the image store", "name": "name", "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 Zone name of the image store", - "name": "zonename", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the protocol of the image store", - "name": "protocol", + "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 scope of the image store", "name": "scope", "type": "scopetype" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the url of the image store", + "name": "url", + "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 ID of the image store", @@ -139515,32 +139532,31 @@ "name": "zoneid", "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", + "name": "jobstatus", + "type": "integer" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ], "since": "3.0.0" }, { - "description": "Enables out-of-band management for a host", + "description": "Disables HA for a host", "isasync": true, - "name": "enableOutOfBandManagementForHost", + "name": "disableHAForHost", "params": [ { - "description": "the ID of the host", + "description": "ID of the host", "length": 255, "name": "hostid", "related": "reconnectHost", @@ -139550,46 +139566,81 @@ ], "related": "", "response": [ + {}, { - "description": "the operation result description", - "name": "description", + "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 host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, + { + "description": "operation status", + "name": "status", + "type": "boolean" + }, + { + "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" - }, - {}, + } + ], + "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", - "type": "string" - }, + "related": "reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the out-of-band management interface password", - "name": "password", + "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 ID of the host", + "name": "hostid", + "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", + "description": "the operation result", + "name": "status", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" }, { "description": "the out-of-band management action (if issued)", @@ -139597,25 +139648,46 @@ "type": "string" }, { - "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", - "name": "status", - "type": "boolean" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, {}, + {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "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": "the out-of-band management interface username", + "name": "username", "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" } ], "since": "4.9.0" @@ -139635,28 +139707,28 @@ } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -139664,27 +139736,6 @@ "isasync": false, "name": "listKubernetesSupportedVersions", "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" - }, { "description": "the minimum semantic version for the Kubernetes supported version to be listed", "length": 255, @@ -139700,6 +139751,13 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the ID of the minimum Kubernetes supported version", "length": 255, @@ -139715,24 +139773,38 @@ "related": "listZones", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the id of the Kubernetes supported version", + "name": "id", + "type": "string" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, + {}, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { @@ -139741,23 +139813,18 @@ "type": "boolean" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" - }, - { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { @@ -139766,46 +139833,51 @@ "type": "integer" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" + }, + { + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "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 date when this Kubernetes supported version was created", "name": "created", "type": "date" }, - { - "description": "the id of the Kubernetes supported version", - "name": "id", - "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 id of the zone in which Kubernetes supported version is available", - "name": "zoneid", - "type": "string" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, + {}, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" - }, - {} + } ] }, { @@ -139814,17 +139886,17 @@ "name": "addNiciraNvpDevice", "params": [ { - "description": "Hostname of ip address of the Nicira NVP Controller.", + "description": "Credentials to access the Nicira Controller API", "length": 255, - "name": "hostname", + "name": "username", "required": true, "type": "string" }, { - "description": "The L3 Gateway Service UUID configured on the Nicira Controller", + "description": "The Transportzone UUID configured on the Nicira Controller", "length": 255, - "name": "l3gatewayserviceuuid", - "required": false, + "name": "transportzoneuuid", + "required": true, "type": "string" }, { @@ -139834,13 +139906,6 @@ "required": false, "type": "string" }, - { - "description": "Credentials to access the Nicira Controller API", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, { "description": "the Physical Network ID", "length": 255, @@ -139849,6 +139914,13 @@ "required": true, "type": "uuid" }, + { + "description": "The L3 Gateway Service UUID configured on the Nicira Controller", + "length": 255, + "name": "l3gatewayserviceuuid", + "required": false, + "type": "string" + }, { "description": "Credentials to access the Nicira Controller API", "length": 255, @@ -139857,9 +139929,9 @@ "type": "string" }, { - "description": "The Transportzone UUID configured on the Nicira Controller", + "description": "Hostname of ip address of the Nicira NVP Controller.", "length": 255, - "name": "transportzoneuuid", + "name": "hostname", "required": true, "type": "string" } @@ -139867,34 +139939,34 @@ "related": "", "response": [ { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "name of the provider", + "name": "provider", "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": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, + {}, { "description": "device id of the Nicire Nvp", "name": "nvpdeviceid", "type": "string" }, { - "description": "device name", - "name": "niciradevicename", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { @@ -139903,21 +139975,21 @@ "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, + {}, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "device name", + "name": "niciradevicename", "type": "string" - }, - {} + } ] }, { @@ -139927,41 +139999,50 @@ "params": [], "related": "", "response": [ + {}, { - "description": "Number of internal LBs", - "name": "ilbvms", + "description": "Number of hypervisor hosts", + "name": "hosts", "type": "integer" }, - {}, - {}, { - "description": "Number of clusters", - "name": "clusters", + "description": "Number of zones", + "name": "zones", "type": "integer" }, { - "description": "Number of storage pools", - "name": "storagepools", + "description": "Number of images stores", + "name": "imagestores", "type": "integer" }, { - "description": "Number of pods", - "name": "pods", + "description": "Number of object stores", + "name": "objectstores", "type": "integer" }, { - "description": "Number of zones", - "name": "zones", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Number of object stores", - "name": "objectstores", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Number of routers", + "name": "routers", "type": "integer" }, { - "description": "Number of management servers", - "name": "managementservers", + "description": "Number of Alerts", + "name": "alerts", + "type": "integer" + }, + { + "description": "Number of storage pools", + "name": "storagepools", "type": "integer" }, { @@ -139975,35 +140056,26 @@ "type": "integer" }, { - "description": "Number of routers", - "name": "routers", + "description": "Number of pods", + "name": "pods", "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", + "description": "Number of clusters", + "name": "clusters", "type": "integer" }, { - "description": "Number of Alerts", - "name": "alerts", + "description": "Number of management servers", + "name": "managementservers", "type": "integer" }, { - "description": "Number of images stores", - "name": "imagestores", + "description": "Number of internal LBs", + "name": "ilbvms", "type": "integer" }, - { - "description": "Number of hypervisor hosts", - "name": "hosts", - "type": "integer" - } + {} ], "since": "4.9.3" }, @@ -140013,34 +140085,32 @@ "name": "listUsageRecords", "params": [ { - "description": "Flag to enable display of Tags for a resource", + "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", "length": 255, - "name": "includetags", + "name": "oldformat", "required": false, "type": "boolean" }, { - "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": "Flag to enable display of Tags for a resource", "length": 255, - "name": "isrecursive", + "name": "includetags", "required": false, - "since": "4.15", "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List usage records for specified project", + "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": "projectid", - "related": "", - "required": false, - "type": "uuid" + "name": "enddate", + "required": true, + "type": "date" }, { "description": "List usage records for the specified usage type", @@ -140050,18 +140120,19 @@ "type": "long" }, { - "description": "", + "description": "List usage records for the specified user.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List usage records for the specified user.", + "description": "List usage records for specified project", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "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.", @@ -140071,52 +140142,58 @@ "type": "date" }, { - "description": "List usage records for the specified account", + "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts", + "name": "usageid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", + "description": "List usage records for the specified domain.", "length": 255, - "name": "usageid", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "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": "oldformat", + "name": "isrecursive", "required": false, + "since": "4.15", "type": "boolean" }, { - "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.", + "description": "List usage records for the specified account", "length": 255, - "name": "enddate", - "required": true, - "type": "date" + "name": "accountid", + "related": "enableAccount,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List usage records for the specified domain.", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ + { + "description": "offering ID", + "name": "offeringid", + "type": "string" + }, { "description": "resource size", "name": "size", @@ -140127,53 +140204,109 @@ "name": "isdefault", "type": "boolean" }, + { + "description": "raw usage in hours", + "name": "rawusage", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "path of the domain to which the usage reocrd belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", + "type": "boolean" + }, { "description": "the domain the resource is associated with", "name": "domain", "type": "string" }, { - "description": "start date of the usage record", - "name": "startdate", - "type": "date" + "description": "template ID", + "name": "templateid", + "type": "string" }, { - "description": "virtual machine os type ID", - "name": "ostypeid", + "description": "id of the resource", + "name": "usageid", "type": "string" }, { - "description": "virtual machine ID", - "name": "virtualmachineid", + "description": "the project name of the resource", + "name": "project", "type": "string" }, + { + "description": "virtual size of resource", + "name": "virtualsize", + "type": "long" + }, { "description": "memory allocated for the resource", "name": "memory", "type": "long" }, + { + "description": "speed of each cpu of resource", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "id of the vpc", + "name": "vpcid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "description of the usage record", + "name": "description", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "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 key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -140182,18 +140315,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -140202,67 +140335,31 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, - { - "description": "virtual machine os category name", - "name": "oscategoryname", - "type": "string" - }, { "description": "the domain ID", "name": "domainid", "type": "string" }, - { - "description": "template ID", - "name": "templateid", - "type": "string" - }, - { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "raw usage in hours", - "name": "rawusage", - "type": "string" - }, - {}, { "description": "virtual machine os display name", "name": "osdisplayname", "type": "string" }, { - "description": "resource or virtual machine name", - "name": "name", + "description": "virtual machine guest os category ID", + "name": "oscategoryid", "type": "string" }, { - "description": "end date of the usage record", - "name": "enddate", - "type": "date" - }, - { - "description": "resource type", - "name": "type", + "description": "resource or virtual machine name", + "name": "name", "type": "string" }, { @@ -140271,59 +140368,38 @@ "type": "integer" }, { - "description": "number of cpu of resource", - "name": "cpunumber", - "type": "long" - }, - { - "description": "the project id of the resource", - "name": "projectid", - "type": "string" - }, - { - "description": "offering ID", - "name": "offeringid", + "description": "id of the network", + "name": "networkid", "type": "string" }, { - "description": "speed of each cpu of resource", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "usage in hours", - "name": "usage", - "type": "string" + "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", + "name": "issystem", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "end date of the usage record", + "name": "enddate", + "type": "date" }, { - "description": "id of the network", - "name": "networkid", + "description": "the project id of the resource", + "name": "projectid", "type": "string" }, { - "description": "the project name of the resource", - "name": "project", + "description": "the user account name", + "name": "account", "type": "string" }, - {}, - { - "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", - "name": "issystem", - "type": "boolean" - }, { - "description": "virtual size of resource", - "name": "virtualsize", + "description": "number of cpu of resource", + "name": "cpunumber", "type": "long" }, { - "description": "the user account Id", - "name": "accountid", + "description": "virtual machine os type ID", + "name": "ostypeid", "type": "string" }, { @@ -140332,39 +140408,35 @@ "type": "string" }, { - "description": "id of the vpc", - "name": "vpcid", + "description": "usage in hours", + "name": "usage", "type": "string" }, { - "description": "description of the usage record", - "name": "description", - "type": "string" + "description": "start date of the usage record", + "name": "startdate", + "type": "date" }, { - "description": "virtual machine guest os category ID", - "name": "oscategoryid", + "description": "resource type", + "name": "type", "type": "string" }, + {}, { - "description": "the user account name", - "name": "account", + "description": "virtual machine ID", + "name": "virtualmachineid", "type": "string" }, { - "description": "id of the resource", - "name": "usageid", + "description": "virtual machine os category name", + "name": "oscategoryname", "type": "string" }, { - "description": "path of the domain to which the usage reocrd belongs", - "name": "domainpath", + "description": "the user account Id", + "name": "accountid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -140382,162 +140454,51 @@ "type": "uuid" } ], - "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", - "type": "string" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "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 ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, + "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ { - "description": "name of the availability zone", - "name": "zonename", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "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": "the project name of the vpn", - "name": "project", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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 write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "cluster id of the volume", + "name": "clusterid", "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" }, { @@ -140545,33 +140506,18 @@ "name": "diskkbswrite", "type": "long" }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -140580,8 +140526,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -140589,24 +140535,29 @@ "name": "domainpath", "type": "string" }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "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" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -140618,93 +140569,133 @@ "type": "set" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "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": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "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 service offering for root disk", "name": "serviceofferingname", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "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 project name of the vpn", + "name": "project", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -140713,8 +140704,8 @@ "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { @@ -140723,50 +140714,91 @@ "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "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": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "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 template for the virtual machine", + "name": "templatename", + "type": "string" }, - {}, { "description": "the VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + {}, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { "description": "the state of the disk volume", @@ -140774,38 +140806,78 @@ "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "pod id of the volume", + "name": "podid", + "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": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "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 repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" } ], @@ -140816,6 +140888,14 @@ "isasync": true, "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { "description": "Tungsten-Fabric logical router uuid", "length": 255, @@ -140829,30 +140909,27 @@ "name": "networkuuid", "required": true, "type": "string" - }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" } ], "related": "", "response": [ + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, { "description": "Tungsten-Fabric logical router 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", @@ -140863,20 +140940,15 @@ "name": "name", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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 name", - "name": "zonename", - "type": "string" } ] }, @@ -140899,6 +140971,13 @@ "required": false, "type": "string" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the ID of the storage pool", "length": 255, @@ -140907,13 +140986,6 @@ "required": true, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -140925,71 +140997,71 @@ "related": "", "response": [ { - "description": "name of the primary storage hosting the volume", - "name": "storage", + "description": "the format of the volume", + "name": "format", "type": "string" }, { - "description": "volume details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the virtual size of the volume", + "name": "virtualsize", + "type": "long" }, - {}, { - "description": "type of the primary storage hosting the volume", - "name": "storagetype", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the size of the volume", - "name": "size", - "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 volume", - "name": "storageid", + "description": "the full path of the volume", + "name": "fullpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the primary storage hosting the volume", + "name": "storagetype", "type": "string" }, + {}, { - "description": "the full path of the volume", - "name": "fullpath", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the encrypt format of the volume", - "name": "encryptformat", + "description": "id of the primary storage hosting the volume", + "name": "storageid", "type": "string" }, { - "description": "the virtual size of the volume", - "name": "virtualsize", - "type": "long" + "description": "the encrypt format of the volume", + "name": "encryptformat", + "type": "string" }, - {}, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "name of the primary storage hosting the volume", + "name": "storage", "type": "string" }, { - "description": "the format of the volume", - "name": "format", - "type": "string" + "description": "the size of the volume", + "name": "size", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "volume details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "the name of the volume", @@ -141004,21 +141076,6 @@ "isasync": false, "name": "listZonesMetrics", "params": [ - { - "description": "the network type of the zone that the virtual machine belongs to", - "length": 255, - "name": "networktype", - "required": false, - "type": "string" - }, - { - "description": "the ID of the zone", - "length": 255, - "name": "id", - "related": "listZones", - "required": false, - "type": "uuid" - }, { "description": "flag to display the resource image for the zones", "length": 255, @@ -141026,14 +141083,6 @@ "required": false, "type": "boolean" }, - { - "description": "List zones by resource tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "since": "4.3", - "type": "map" - }, { "description": "flag to display the capacity of the zones", "length": 255, @@ -141042,11 +141091,11 @@ "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.", + "description": "", "length": 255, - "name": "available", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "the name of the zone", @@ -141055,6 +141104,13 @@ "required": false, "type": "string" }, + { + "description": "the network type of the zone that the virtual machine belongs to", + "length": 255, + "name": "networktype", + "required": false, + "type": "string" + }, { "description": "the ID of the domain associated with the zone", "length": 255, @@ -141064,13 +141120,18 @@ "type": "uuid" }, { - "description": "the IDs of the zones, mutually exclusive with id", + "description": "List by keyword", "length": 255, - "name": "ids", - "related": "listZones", + "name": "keyword", "required": false, - "since": "4.19.0", - "type": "list" + "type": "string" + }, + { + "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": "", @@ -141080,41 +141141,57 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "List zones by resource tags (key/value pairs)", "length": 255, - "name": "keyword", + "name": "tags", "required": false, - "type": "string" + "since": "4.3", + "type": "map" }, { - "description": "", + "description": "the ID of the zone", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "the IDs of the zones, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "listZones", + "required": false, + "since": "4.19.0", + "type": "list" } ], "related": "", "response": [ { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "state of the cluster", + "name": "state", + "type": "string" + }, + { + "description": "AS Number Range", + "name": "asnrange", + "type": "string" }, { "description": "the type of the zone - core or edge", @@ -141122,33 +141199,84 @@ "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" + }, + { + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the total cpu used in GiB", + "name": "memoryused", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", "type": "boolean" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, + { + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" + }, + { + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, + { + "description": "Zone id", + "name": "id", + "type": "string" + }, + {}, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", "type": "boolean" }, { @@ -141157,22 +141285,53 @@ "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, + { + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", + "type": "string" + }, + { + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", "type": "boolean" }, + { + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" + }, + {}, + { + "description": "the total cpu used in Ghz", + "name": "cpuused", + "type": "string" + }, + { + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, { "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { - "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" }, { @@ -141186,38 +141345,38 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], @@ -141229,57 +141388,32 @@ "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "state of the cluster", - "name": "state", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" }, - { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" - }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ { - "description": "the Zone name", - "name": "zonename", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -141288,18 +141422,23 @@ "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, { @@ -141313,41 +141452,36 @@ "type": "short" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Zone ID", + "name": "zoneid", "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" } ], "type": "list" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { @@ -141356,120 +141490,53 @@ "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" - }, - { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "healthy / total clusters in the zone", + "name": "clusters", "type": "string" }, - { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" - }, { "description": "memory allocated disable threshold exceeded", "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", - "type": "string" - }, - { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" - }, - { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", - "type": "string" - }, - {}, - { - "description": "Zone description", - "name": "description", - "type": "string" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" - }, - { - "description": "healthy / total clusters in the zone", - "name": "clusters", - "type": "string" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" - }, - { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, - {}, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { @@ -141478,9 +141545,14 @@ "type": "boolean" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.9.3" @@ -141499,68 +141571,74 @@ "type": "uuid" }, { - "description": "the url to which the ISO would be extracted", - "length": 2048, - "name": "url", - "required": false, + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, "type": "string" }, { "description": "the ID of the template", "length": 255, "name": "id", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, + "description": "the url to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, "type": "string" } ], "related": "extractSnapshot", "response": [ + { + "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 mode of extraction - upload or download", - "name": "extractMode", - "type": "string" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "", - "name": "resultstring", + "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": "the name of the extracted object", + "name": "name", + "type": "string" }, + {}, { - "description": "type of the storage", - "name": "storagetype", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "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", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { @@ -141568,41 +141646,35 @@ "name": "created", "type": "date" }, - { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" - }, - { - "description": "the status of the extraction", - "name": "status", - "type": "string" - }, { "description": "zone ID the object was extracted from", "name": "zoneid", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "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 id of extracted object", - "name": "id", + "description": "the status of the extraction", + "name": "status", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -141616,34 +141688,34 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "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": "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" - } + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ] }, { @@ -141652,12 +141724,12 @@ "name": "updateIpAddress", "params": [ { - "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 IP to the end user or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" }, { "description": "the ID of the public IP address to update", @@ -141668,126 +141740,69 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the IP 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": "associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "the account the public IP address is associated with", - "name": "account", - "type": "string" - }, - { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "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 zone the public IP address belongs to", - "name": "zonename", + "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 virtual network for the IP address", - "name": "forvirtualnetwork", + "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 project id of the ipaddress", - "name": "projectid", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", "type": "boolean" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "public IP address id", - "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": "VPC id the ip belongs to", - "name": "vpcid", + "description": "VPC name the ip belongs to", + "name": "vpcname", "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": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", "type": "boolean" }, { @@ -141796,59 +141811,45 @@ "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, + {}, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { "description": "the list of resource tags associated with ip address", "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", @@ -141865,8 +141866,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -141880,57 +141881,128 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "tag value", "name": "value", "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" } ], "type": "list" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "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 name of the Network where ip belongs to", + "name": "networkname", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" + }, + { + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + { + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, + {}, { "description": "the VLAN associated with the IP address", "name": "vlanname", "type": "string" }, + { + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, { "description": "path of the domain to which the public IP address belongs", "name": "domainpath", "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 project name of the address", + "name": "project", "type": "string" }, { "description": "true if range is dedicated for System VMs", "name": "forsystemvms", "type": "boolean" - }, - { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" } ] }, @@ -141939,14 +142011,6 @@ "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": "network offering ID", "length": 255, @@ -141961,231 +142025,106 @@ "name": "resume", "required": false, "type": "boolean" + }, + { + "description": "the ID of the network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": true, + "type": "uuid" } ], "related": "createNetwork,updateNetwork,listNetworks", "response": [ { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "the list of resource tags associated with network", - "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 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": "tag value", - "name": "value", - "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 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" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" - }, - {}, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, { "description": "the network domain", "name": "networkdomain", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "state of the network", - "name": "state", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "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": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { @@ -142193,166 +142132,187 @@ "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "the provider name", + "description": "the capability name", "name": "name", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ { "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" }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ + }, { - "description": "the capability value", - "name": "value", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the capability name", + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", "name": "name", "type": "string" }, { - "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" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the name of the network", - "name": "name", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the project name of the address", + "name": "project", "type": "string" }, + {}, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "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": "network offering id the network is created from", - "name": "networkofferingid", + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { "description": "ACL Id associated with the VPC network", @@ -142360,63 +142320,176 @@ "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "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", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", "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", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", + "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": "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": "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" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { @@ -142425,39 +142498,49 @@ "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "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 ID of the Network associated with this network", "name": "associatednetworkid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "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 network", - "name": "id", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "MTU configured on the network VR's private interfaces", @@ -142465,34 +142548,23 @@ "type": "integer" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, - {}, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" } ], @@ -142517,6 +142589,14 @@ "required": false, "type": "integer" }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" + }, { "description": "the hypervisor name of the instance", "length": 255, @@ -142530,86 +142610,32 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" } ], "related": "", "response": [ { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", - "type": "string" - }, - { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", - "type": "string" - }, - {}, - { - "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", + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "type": "string" }, - { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" - }, { "description": "the list of nics associated with the virtual machine", "name": "nic", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the name of the corresponding network", + "name": "networkname", "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "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", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -142618,33 +142644,33 @@ "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of the nic", + "name": "gateway", "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 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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -142653,23 +142679,23 @@ "type": "string" }, { - "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" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -142678,18 +142704,18 @@ "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" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -142698,49 +142724,109 @@ "type": "boolean" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" } ], "type": "set" }, - {}, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the operating system ID of the virtual machine", + "name": "osid", + "type": "string" + }, { "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 name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" + }, + { + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" + }, { "description": "the list of disks associated with the virtual machine", "name": "disk", @@ -142751,13 +142837,8 @@ "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" - }, - { - "description": "the position of the disk", - "name": "position", + "description": "the controller unit of the disk", + "name": "controllerunit", "type": "integer" }, { @@ -142766,78 +142847,69 @@ "type": "string" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "the ID of the disk", + "name": "id", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorepath", + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the label of the disk", + "name": "label", "type": "string" }, { - "description": "the ID of the disk", - "name": "id", + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" }, { - "description": "the label of the disk", - "name": "label", + "description": "the controller of the disk", + "name": "datastoretype", "type": "string" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", + "description": "the position of the disk", + "name": "position", "type": "integer" }, { - "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": "datastorename", + "name": "datastorehost", "type": "string" } ], "type": "set" }, { - "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 ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", - "type": "string" + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.14.0" }, @@ -142847,48 +142919,63 @@ "name": "registerTemplate", "params": [ { - "description": "the target hypervisor for the template", + "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": "hypervisor", - "required": true, + "name": "checksum", + "required": false, "type": "string" }, { - "description": "the name of the template", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "details", + "required": false, + "type": "map" }, { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "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 format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "length": 255, + "name": "format", + "required": true, "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "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": "listDomains", + "name": "ostypeid", + "related": "", "required": false, "type": "uuid" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "isdynamicallyscalable", + "name": "ispublic", "required": false, "type": "boolean" }, { - "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": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "zoneids", - "related": "listZones", + "name": "isextractable", "required": false, - "type": "list" + "type": "boolean" + }, + { + "description": "Register template for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", @@ -142899,42 +142986,40 @@ "type": "string" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", + "description": "the name of the template", + "length": 255, + "name": "name", "required": true, "type": "string" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "isrouting", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "deployasis", + "name": "isdynamicallyscalable", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "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": "the target hypervisor for the template", "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "Register template for the project", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "true if the template supports the password reset feature; default is false", @@ -142944,39 +143029,25 @@ "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "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": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", - "length": 255, - "name": "format", + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", "required": true, "type": "string" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "bits", + "name": "isrouting", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the tag for this template.", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "templatetag", + "name": "directdownload", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", @@ -142987,273 +143058,281 @@ "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "isfeatured", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "the ID of the zone the template is to be hosted on", + "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": "zoneid", + "name": "zoneids", "related": "listZones", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "account", + "name": "bits", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, - "type": "map" + "type": "string" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "true if this template requires HVM", "length": 255, - "name": "ispublic", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "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": "true if this template is a featured template, false otherwise", "length": 255, - "name": "checksum", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if this template requires HVM", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "requireshvm", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "the tag for this template.", "length": 255, - "name": "directdownload", + "name": "templatetag", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the template ID", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", + "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 OS type for this template.", + "name": "ostypeid", + "type": "string" }, + {}, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "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": "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 date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "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": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "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": "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 URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "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 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" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "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": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "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 status of the template", - "name": "status", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "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": "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": "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": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, + {}, { "description": "the account name to which the template belongs", "name": "account", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the status of the template", + "name": "status", "type": "string" }, { @@ -143266,13 +143345,13 @@ "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 id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -143281,33 +143360,33 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "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 domain associated with the tag", + "name": "domain", "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -143319,34 +143398,28 @@ "type": "set" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, - {}, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -143355,35 +143428,34 @@ "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "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 size of the template", - "name": "size", - "type": "long" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the tag of this template", + "name": "templatetag", "type": "string" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" } ] }, @@ -143393,38 +143465,26 @@ "name": "listVnfAppliances", "params": [ { - "description": "list by 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": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of AutoScaling VM Group", + "description": "list vms by affinity group", "length": 255, - "name": "autoscalevmgroupid", + "name": "affinitygroupid", "related": "", "required": false, - "since": "4.18.0", - "type": "uuid" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, "type": "uuid" }, { - "description": "the security group ID", + "description": "", "length": 255, - "name": "securitygroupid", - "related": "", + "name": "pagesize", "required": false, - "since": "4.15", - "type": "uuid" + "type": "integer" }, { "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", @@ -143434,191 +143494,190 @@ "type": "string" }, { - "description": "flag to display the resource icon for VMs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "showicon", + "name": "isrecursive", "required": false, - "since": "4.16.0.0", "type": "boolean" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "list vms by ssh keypair name", "length": 255, - "name": "forvirtualnetwork", + "name": "keypair", "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": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list vms by affinity group", + "description": "list vms by template", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "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 ID of the virtual machine", + "description": "list by the backup offering", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "backupofferingid", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "list vms by iso", + "description": "list by network id", "length": 255, - "name": "isoid", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "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.", + "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": "accumulate", + "name": "isvnf", "required": false, - "since": "4.17.0", + "since": "4.19.0", "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", + "description": "List by keyword", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "keyword", "required": false, - "type": "boolean" + "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 vms by vpc", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "domainid", + "related": "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": "the target hypervisor for the template", "length": 255, - "name": "isrecursive", + "name": "hypervisor", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list by the service offering", "length": 255, - "name": "tags", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "map" + "since": "4.4", + "type": "uuid" }, { - "description": "", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "page", + "name": "userid", + "related": "getUser", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, "name": "ids", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "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, "since": "4.4", "type": "list" }, { - "description": "the target hypervisor for the template", + "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": "hypervisor", + "name": "accumulate", "required": false, - "type": "string" + "since": "4.17.0", + "type": "boolean" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "the security group ID", "length": 255, - "name": "userid", - "related": "getUser", + "name": "securitygroupid", + "related": "", "required": false, + "since": "4.15", "type": "uuid" }, { - "description": "list vms by ssh keypair name", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "keypair", + "name": "autoscalevmgroupid", + "related": "", "required": false, - "type": "string" + "since": "4.18.0", + "type": "uuid" }, { - "description": "List by keyword", + "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": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the group ID", "length": 255, - "name": "displayvm", + "name": "groupid", + "related": "", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "the group ID", + "description": "the availability zone ID", "length": 255, - "name": "groupid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", + "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": "isvnf", + "name": "details", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "list" }, { - "description": "the availability zone ID", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "haenable", "required": false, - "type": "uuid" + "since": "4.15", + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list vms by vpc", "length": 255, - "name": "projectid", - "related": "", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, @@ -143631,46 +143690,59 @@ "type": "boolean" }, { - "description": "list vms by template", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "displayvm", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list by the backup offering", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "backupofferingid", + "name": "showicon", "required": false, - "since": "4.17", - "type": "uuid" + "since": "4.16.0.0", + "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": "makes the API's response contains only the resource count", "length": 255, - "name": "name", + "name": "retrieveonlyresourcecount", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list by the service offering", + "description": "list vms by iso", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "isoid", "required": false, - "since": "4.4", "type": "uuid" }, { - "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.", + "description": "the ID of the virtual machine", "length": 255, - "name": "details", + "name": "id", + "related": "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": "list" + "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 resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "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 name of the service offering of the virtual machine", @@ -143678,234 +143750,451 @@ "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + {}, + { + "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 Service from LB rule", + "name": "servicestate", + "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 ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "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 has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "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": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "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 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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "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": "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": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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 domain associated with the tag", - "name": "domainid", + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ + }, { - "description": "the type of the affinity group", - "name": "type", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "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 ID of the affinity group", - "name": "id", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "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" } ], "type": "set" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "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": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "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": "State of the Service from LB rule", - "name": "servicestate", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "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": "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": "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": "publicip", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { "description": "the memory used by the VM in KiB", @@ -143913,88 +144202,113 @@ "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "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 AutoScale VM group", - "name": "autoscalevmgroupid", + "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", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "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": "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "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 project id of the vm", - "name": "projectid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { @@ -144003,58 +144317,68 @@ "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "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 type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "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": "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 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 ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "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 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", @@ -144066,146 +144390,176 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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 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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "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": "customer associated with the tag", + "name": "customer", "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": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" } ], "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 protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "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 project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the domain name of the security group", + "name": "domain", "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 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 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": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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": "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", + "type": "string" + }, { "description": "tag key name", "name": "key", "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -144213,11 +144567,6 @@ "name": "project", "type": "string" }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "path of the Domain associated with the tag", "name": "domainpath", @@ -144229,60 +144578,55 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "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" } ], "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" - }, - { - "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 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", + "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 account owning the security group", + "name": "account", + "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 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", @@ -144293,6 +144637,11 @@ "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", @@ -144304,13 +144653,8 @@ "type": "string" }, { - "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" }, { @@ -144319,23 +144663,23 @@ "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -144347,28 +144691,8 @@ "type": "set" }, { - "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 name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -144379,388 +144703,136 @@ ], "type": "set" }, - {}, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "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": "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "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 gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "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 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 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": "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": "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 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": "the netmask of the nic", - "name": "netmask", - "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - } - ], - "type": "set" - }, - {}, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "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" - }, - { - "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 name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, { "description": "the userdata override policy with the userdata provided while deploying VM", "name": "userdatapolicy", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "User VM type", + "name": "vmtype", "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 list of resource tags associated", + "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 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": "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": "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 password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "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 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", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the project id of the vm", + "name": "projectid", "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" } ], @@ -144772,18 +144844,19 @@ "name": "addStratosphereSsp", "params": [ { - "description": "stratosphere ssp api name", + "description": "stratosphere ssp api password", "length": 255, - "name": "name", - "required": true, + "name": "password", + "required": false, "type": "string" }, { - "description": "stratosphere ssp api username", + "description": "the zone ID", "length": 255, - "name": "username", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { "description": "stratosphere ssp server url", @@ -144793,19 +144866,18 @@ "type": "string" }, { - "description": "stratosphere ssp api password", + "description": "stratosphere ssp api name", "length": 255, - "name": "password", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the zone ID", + "description": "stratosphere ssp api username", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "username", + "required": false, + "type": "string" }, { "description": "stratosphere ssp tenant uuid", @@ -144818,8 +144890,8 @@ "related": "", "response": [ { - "description": "zone which this ssp controls", - "name": "zoneid", + "description": "url of ssp endpoint", + "name": "url", "type": "string" }, { @@ -144827,28 +144899,28 @@ "name": "hostid", "type": "string" }, + {}, { - "description": "name", - "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": "zone which this ssp controls", + "name": "zoneid", "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": "url of ssp endpoint", - "name": "url", + "description": "name", + "name": "name", "type": "string" - }, - {} + } ] }, { @@ -144856,13 +144928,6 @@ "isasync": false, "name": "createStoragePool", "params": [ - { - "description": "the storage provider name", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, { "description": "IOPS CloudStack can provision from this storage pool", "length": 255, @@ -144871,63 +144936,68 @@ "type": "long" }, { - "description": "whether the storage should be managed by CloudStack", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "managed", + "name": "capacitybytes", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the details for the storage pool", + "description": "the tags for the storage pool", "length": 255, - "name": "details", + "name": "tags", "required": false, - "type": "map" + "type": "string" }, { - "description": "the cluster ID for the storage pool", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "istagarule", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the scope of the storage: cluster or zone", + "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": "scope", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "the Pod ID for the storage pool", + "description": "the details for the storage pool", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the Zone ID for the storage pool", + "description": "the name for the storage pool", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the tags for the storage pool", + "description": "whether the storage should be managed by CloudStack", "length": 255, - "name": "tags", + "name": "managed", + "required": false, + "type": "boolean" + }, + { + "description": "the scope of the storage: cluster or zone", + "length": 255, + "name": "scope", "required": false, "type": "string" }, { - "description": "the name for the storage pool", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "the URL of the storage pool", @@ -144937,32 +145007,34 @@ "type": "string" }, { - "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", + "description": "the storage provider name", "length": 255, - "name": "hypervisor", + "name": "provider", "required": false, "type": "string" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "capacitybytes", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "the cluster ID for the storage pool", "length": 255, - "name": "istagarule", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { @@ -144971,38 +145043,30 @@ "type": "boolean" }, { - "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", - "type": "string" - }, - { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "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": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { @@ -145011,33 +145075,18 @@ "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" - }, - { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the storage pool path", - "name": "path", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { @@ -145051,21 +145100,19 @@ "type": "map" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, - {}, - {}, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { "description": "the IP address of the storage pool", @@ -145073,44 +145120,44 @@ "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { "description": "the host's currently used disk size", "name": "disksizeused", "type": "long" }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, { "description": "total min IOPS currently in use by volumes", "name": "allocatediops", "type": "long" }, { - "description": "the 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 storage pool path", + "name": "path", "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 hypervisor type of the storage pool", @@ -145118,9 +145165,34 @@ "type": "string" }, { - "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": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the storage pool type", + "name": "type", + "type": "string" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" } ] }, @@ -145129,13 +145201,6 @@ "isasync": false, "name": "findStoragePoolsForMigration", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -145150,6 +145215,13 @@ "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the ID of the volume", "length": 255, @@ -145162,29 +145234,40 @@ "related": "cancelStorageMaintenance,enableStorageMaintenance", "response": [ { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + {}, { "description": "the state of the storage pool", "name": "state", "type": "storagepoolstatus" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "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 Pod ID of the storage pool", @@ -145192,48 +145275,38 @@ "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 date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the storage pool path", - "name": "path", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { @@ -145241,29 +145314,19 @@ "name": "clustername", "type": "string" }, - { - "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 host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, { "description": "the nfs mount options for the storage pool", "name": "nfsmountopts", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "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" }, { @@ -145271,57 +145334,66 @@ "name": "overprovisionfactor", "type": "string" }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, {}, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "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" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the name of the storage pool", - "name": "name", - "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", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" } ] }, @@ -145331,32 +145403,31 @@ "name": "deleteTungstenFabricFirewallRule", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric firewall rule", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "firewallruleuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall rule", + "description": "the ID of zone", "length": 255, - "name": "firewallruleuuid", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "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": "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" }, { @@ -145364,6 +145435,7 @@ "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -145388,34 +145460,30 @@ "related": "listCiscoNexusVSMs", "response": [ { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, + {}, + {}, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" - }, - { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, - {}, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", - "type": "string" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", - "type": "string" + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" }, { - "description": "device name", - "name": "vsmdevicename", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, { @@ -145423,41 +145491,45 @@ "name": "vsmdevicestate", "type": "string" }, + { + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" - }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "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 Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", "type": "int" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -145466,13 +145538,6 @@ "isasync": true, "name": "createStorageNetworkIpRange", "params": [ - { - "description": "the netmask for storage network", - "length": 255, - "name": "netmask", - "required": true, - "type": "string" - }, { "description": "UUID of pod where the ip range belongs to", "length": 255, @@ -145482,50 +145547,57 @@ "type": "uuid" }, { - "description": "the beginning IP address", + "description": "the ending IP address", "length": 255, - "name": "startip", + "name": "endip", + "required": false, + "type": "string" + }, + { + "description": "the gateway for storage network", + "length": 255, + "name": "gateway", "required": true, "type": "string" }, { - "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": "the netmask for storage network", "length": 255, - "name": "vlan", - "required": false, - "type": "integer" + "name": "netmask", + "required": true, + "type": "string" }, { - "description": "the gateway for storage network", + "description": "the beginning IP address", "length": 255, - "name": "gateway", + "name": "startip", "required": true, "type": "string" }, { - "description": "the ending IP address", + "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": "endip", + "name": "vlan", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, + {}, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -145534,39 +145606,39 @@ "type": "integer" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, - {}, { "description": "the uuid of storage network IP range.", "name": "id", "type": "string" }, + { + "description": "the network uuid of storage network IP range", + "name": "networkid", + "type": "string" + }, { "description": "the ID or VID of the VLAN.", "name": "vlan", "type": "integer" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", - "type": "string" - }, - { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, + {}, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" } ], @@ -145577,13 +145649,6 @@ "isasync": true, "name": "configureOvsElement", "params": [ - { - "description": "Enabled/Disabled the service provider", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - }, { "description": "the ID of the ovs provider", "length": 255, @@ -145591,33 +145656,36 @@ "related": "configureOvsElement", "required": true, "type": "uuid" + }, + { + "description": "Enabled/Disabled the service provider", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + {}, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { @@ -145625,32 +145693,36 @@ "name": "account", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Enabled/Disabled the service provider", "name": "enabled", "type": "boolean" }, + { + "description": "path of the domain to which the provider belongs", + "name": "domainpath", + "type": "string" + }, + {}, + { + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" + }, { "description": "the id of the ovs", "name": "id", "type": "string" }, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "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", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -145660,38 +145732,23 @@ "name": "listSystemVmsUsageHistory", "params": [ { - "description": "name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, - { - "description": "the IDs of the system VMs, mutually exclusive with id.", - "length": 255, - "name": "ids", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": false, - "type": "list" - }, - { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -145699,7 +145756,7 @@ "description": "the ID of the system VM.", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "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" }, @@ -145711,19 +145768,34 @@ "type": "date" }, { - "description": "List by keyword", + "description": "the IDs of the system VMs, mutually exclusive with id.", "length": 255, - "name": "keyword", + "name": "ids", + "related": "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": "list" + }, + { + "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": "name", "required": false, "type": "string" + }, + { + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" } ], "related": "", "response": [ { - "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", + "type": "string" }, { "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", @@ -145731,26 +145803,98 @@ "type": "string" }, {}, - {}, - { - "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", - "type": "string" - }, { "description": "the list of VM stats", "name": "stats", + "response": [ + { + "description": "the VM's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", + "name": "diskioread", + "type": "long" + }, + { + "description": "the amount of uploaded data by the VM in MiB", + "name": "networkwrite", + "type": "string" + }, + { + "description": "the total disk iops since the last stats retrieval", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "the VM's free memory in KB or -1 if it cannot be gathered", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the time when the VM stats were collected. The format is \"yyyy-MM-dd hh:mm:ss\"", + "name": "timestamp", + "type": "date" + }, + { + "description": "the memory used by the VM in KB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the VM's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the target memory in VM (KB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the amount of downloaded data by the VM in MiB", + "name": "networkread", + "type": "string" + }, + { + "description": "the amount (percentage) of the VM's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + } + ], "type": "list" }, + {}, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.18.0" @@ -145770,6 +145914,7 @@ } ], "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -145790,8 +145935,7 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {} + } ] }, { @@ -145800,10 +145944,17 @@ "name": "createFirewallRule", "params": [ { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "description": "the ending port of firewall rule", "length": 255, - "name": "protocol", - "required": true, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "type of firewallrule: system/user", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { @@ -145815,11 +145966,11 @@ "type": "boolean" }, { - "description": "type of firewallrule: system/user", + "description": "error code for this icmp message", "length": 255, - "name": "type", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" }, { "description": "the starting port of firewall rule", @@ -145836,18 +145987,19 @@ "type": "list" }, { - "description": "error code for this icmp message", + "description": "the IP address id of the port forwarding rule", "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { - "description": "the ending port of firewall rule", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "name": "protocol", + "required": true, + "type": "string" }, { "description": "type of the ICMP message being sent", @@ -145855,35 +146007,47 @@ "name": "icmptype", "required": false, "type": "integer" + } + ], + "related": "updateEgressFirewallRule", + "response": [ + { + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" }, { - "description": "the IP address id of the port forwarding rule", - "length": 255, + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the public ip address id for the firewall rule", "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - } - ], - "related": "updateEgressFirewallRule", - "response": [ + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -145892,23 +146056,23 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "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": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -145917,22 +146081,17 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "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", @@ -145940,76 +146099,61 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - {}, - {}, - { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the ID of the firewall rule", + "name": "id", "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the protocol of the firewall rule", + "name": "protocol", "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 public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { "description": "the state of the rule", "name": "state", "type": "string" }, + {}, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" + }, + {}, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" } ] }, @@ -146018,13 +146162,6 @@ "isasync": true, "name": "createVolume", "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, - "type": "string" - }, { "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", "length": 255, @@ -146034,11 +146171,12 @@ "type": "uuid" }, { - "description": "the account associated with the disk volume. Must be used with the domainId parameter.", + "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": "account", + "name": "virtualmachineid", + "related": "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 name of the disk volume", @@ -146047,6 +146185,21 @@ "required": false, "type": "string" }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "type": "string" + }, + { + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, { "description": "an optional field, whether to display the volume to the end user or not.", "length": 255, @@ -146055,20 +146208,18 @@ "type": "boolean" }, { - "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", + "description": "Arbitrary volume size", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "size", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the ID of the availability zone", + "description": "the account associated with the disk volume. Must be used with the domainId parameter.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "min iops", @@ -146078,28 +146229,21 @@ "type": "long" }, { - "description": "the project associated with the volume. Mutually exclusive with account parameter", + "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "projectid", + "name": "diskofferingid", "related": "", "required": false, "type": "uuid" }, { - "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.", + "description": "the project associated with the volume. Mutually exclusive with account parameter", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, - { - "description": "Arbitrary volume size", - "length": 255, - "name": "size", - "required": false, - "type": "long" - }, { "description": "max iops", "length": 255, @@ -146108,10 +146252,10 @@ "type": "long" }, { - "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", + "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": "diskofferingid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" } @@ -146119,240 +146263,215 @@ "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "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 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": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "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": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "name of the service offering for root disk", - "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 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": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, + {}, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "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": "name of the virtual machine", - "name": "vmname", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "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": "name of the disk offering", - "name": "diskofferingname", + "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 boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "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 display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { @@ -146361,65 +146480,115 @@ "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "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": "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": "the format of the disk encryption if applicable", + "name": "encryptformat", + "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": "the date the disk volume 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 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": "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 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" + } + ], + "type": "set" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { @@ -146428,28 +146597,28 @@ "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "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 status of the volume", + "name": "status", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { @@ -146458,28 +146627,23 @@ "type": "string" }, { - "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", - "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", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { @@ -146488,19 +146652,19 @@ "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "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", + "type": "string" }, { - "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": "pod id of the volume", @@ -146508,38 +146672,18 @@ "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" } ] @@ -146550,50 +146694,39 @@ "name": "listVMSnapshot", "params": [ { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", + "description": "lists snapshot by snapshot name or display name", "length": 255, - "name": "vmsnapshotids", - "related": "listVMSnapshot,createVMSnapshot", + "name": "name", "required": false, - "since": "4.9", - "type": "list" + "type": "string" }, { - "description": "the ID of the vm", + "description": "List by keyword", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists snapshot by snapshot name or display name", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. 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": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -146604,11 +146737,11 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "state of the virtual machine snapshot", @@ -146618,120 +146751,63 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "The ID of the VM snapshot", "length": 255, - "name": "page", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "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.", + "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", "length": 255, - "name": "listall", + "name": "vmsnapshotids", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "boolean" + "since": "4.9", + "type": "list" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "The ID of the VM snapshot", + "description": "the ID of the vm", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "virtualmachineid", + "related": "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": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" } ], "related": "createVMSnapshot", "response": [ { - "description": "the description of the vm snapshot", - "name": "description", - "type": "string" - }, - {}, - { - "description": "the parent ID of the vm snapshot", - "name": "parent", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "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 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": "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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", + "description": "VM Snapshot type", + "name": "type", "type": "string" }, { @@ -146744,80 +146820,51 @@ "name": "created", "type": "date" }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the vm snapshot", - "name": "id", - "type": "string" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the vm snapshot", - "name": "name", - "type": "string" - }, - { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "path of the domain to which the disk volume belongs", - "name": "domainpath", + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "the description of the vm snapshot", + "name": "description", "type": "string" }, { - "description": "VM Snapshot type", - "name": "type", + "description": "the Zone name of the vm snapshot", + "name": "zonename", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the display name of the vm snapshot", + "name": "displayname", "type": "string" }, - {}, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "type": "string" }, { @@ -146826,145 +146873,186 @@ "type": "string" }, { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - } - ], - "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 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": "path of the domain to which the disk volume belongs", + "name": "domainpath", "type": "string" }, { - "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": "the account associated with the disk volume", + "name": "account", "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 parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { - "description": "The ID of the network ACL rule that is being moved to a new position.", - "length": 255, + "description": "the ID of the vm snapshot", "name": "id", - "required": true, - "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, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", "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", + "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": "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": "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" + } + ], + "type": "set" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the parent displayName of the vm snapshot", + "name": "parentName", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "string" + } + ], + "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 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 ID of the ACL Item", - "name": "id", + "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 traffic type for the ACL", - "name": "traffictype", + "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 name of the ACL this item belongs to", - "name": "aclname", + "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 ID of the ACL this item belongs to", - "name": "aclid", + "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": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the network ACLs", "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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -146973,8 +147061,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -146983,59 +147071,115 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "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 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" }, { - "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", "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": "the starting port of ACL's port range", + "name": "startport", + "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", "type": "string" }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "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 ACL", + "name": "protocol", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "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 ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the state of the rule", + "name": "state", "type": "string" - } + }, + { + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + {}, + { + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + {} ] }, { @@ -147061,26 +147205,26 @@ } ], "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": "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" }, {} ] @@ -147098,11 +147242,11 @@ "type": "string" }, { - "description": "DHCP server device ID", + "description": "", "length": 255, - "name": "id", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { "description": "List by keyword", @@ -147127,11 +147271,11 @@ "type": "uuid" }, { - "description": "", + "description": "DHCP server device ID", "length": 255, - "name": "pagesize", + "name": "id", "required": false, - "type": "integer" + "type": "long" } ], "related": "", @@ -147146,23 +147290,11 @@ "name": "id", "type": "string" }, - {}, - { - "description": "name of the provider", - "name": "dhcpservertype", - "type": "string" - }, - {}, { "description": "url", "name": "url", "type": "string" }, - { - "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", @@ -147172,7 +147304,19 @@ "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": "name of the provider", + "name": "dhcpservertype", + "type": "string" + }, + {}, + {} ] }, { @@ -147191,44 +147335,40 @@ ], "related": "cancelStorageMaintenance", "response": [ + {}, { - "description": "the storage pool path", - "name": "path", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", + "description": "the storage pool custom stats", + "name": "storagecustomstats", "type": "map" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { @@ -147237,23 +147377,39 @@ "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + {}, + { + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { @@ -147262,29 +147418,28 @@ "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, - {}, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { @@ -147293,65 +147448,54 @@ "type": "boolean" }, { - "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", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "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 nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, { "description": "the ID of the cluster for the storage pool", "name": "clusterid", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "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 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 hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" } ] }, @@ -147370,28 +147514,28 @@ } ], "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" - } + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.19.0" }, @@ -147411,58 +147555,32 @@ "related": "", "response": [ { - "description": "the list params the api accepts", - "name": "params", + "description": "api response fields", + "name": "response", "response": [ { - "description": "version of CloudStack the api was introduced in", - "name": "since", - "type": "string" - }, - { - "description": "parameter type", + "description": "response field type", "name": "type", "type": "string" }, - {}, { - "description": "the name of the api parameter", + "description": "the name of the api response field", "name": "name", "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": "description of the api parameter", + "description": "description of the api response field", "name": "description", "type": "string" }, { - "description": "comma separated related apis to get the parameter", - "name": "related", - "type": "string" + "description": "api response fields", + "name": "response", + "type": "set" } ], "type": "set" }, - { - "description": "version of CloudStack the api was introduced in", - "name": "since", - "type": "string" - }, - { - "description": "response field type", - "name": "type", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -147473,15 +147591,10 @@ "name": "isasync", "type": "boolean" }, - { - "description": "description of the api", - "name": "description", - "type": "string" - }, {}, { - "description": "the name of the api command", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -147490,37 +147603,68 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the api command", + "name": "name", "type": "string" }, {}, { - "description": "api response fields", - "name": "response", + "description": "description of the api", + "name": "description", + "type": "string" + }, + { + "description": "the list params the api accepts", + "name": "params", "response": [ { - "description": "description of the api response field", - "name": "description", + "description": "parameter type", + "name": "type", "type": "string" }, + {}, { - "description": "api response fields", - "name": "response", - "type": "set" + "description": "version of CloudStack the api was introduced in", + "name": "since", + "type": "string" }, { - "description": "the name of the api response field", + "description": "comma separated related apis to get the parameter", + "name": "related", + "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": "the name of the api parameter", "name": "name", "type": "string" }, { - "description": "response field type", - "name": "type", + "description": "description of the api parameter", + "name": "description", "type": "string" } ], "type": "set" + }, + { + "description": "version of CloudStack the api was introduced in", + "name": "since", + "type": "string" + }, + { + "description": "response field type", + "name": "type", + "type": "string" } ], "since": "4.1.0" @@ -147540,28 +147684,28 @@ } ], "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": "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" + } ] }, { @@ -147569,21 +147713,6 @@ "isasync": true, "name": "createVMSnapshot", "params": [ - { - "description": "The ID of the vm", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "The description of the snapshot", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "The display name of the snapshot", "length": 255, @@ -147598,6 +147727,21 @@ "required": false, "type": "boolean" }, + { + "description": "The ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "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 description of the snapshot", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, { "description": "quiesce vm if true", "length": 255, @@ -147609,39 +147753,93 @@ "related": "", "response": [ { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" + }, + { + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, - {}, {}, { - "description": "indicates if this is current snapshot", - "name": "current", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the display name of the vm snapshot", + "name": "displayname", "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": "the parent displayName of the vm snapshot", + "name": "parentName", + "type": "string" + }, + { + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" + }, + { + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "VM Snapshot type", + "name": "type", + "type": "string" + }, + { + "description": "the name of the vm snapshot", + "name": "name", + "type": "string" + }, + { + "description": "the description of the vm snapshot", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the vm snapshot", + "name": "id", + "type": "string" + }, + { + "description": "the Zone name of the vm snapshot", + "name": "zonename", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -147650,66 +147848,61 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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 account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the name of the vm snapshot", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { @@ -147718,79 +147911,30 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "path of the domain to which the disk volume belongs", + "name": "domainpath", + "type": "string" }, { "description": "the state of the vm snapshot", "name": "state", "type": "state" }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "string" - }, - { - "description": "VM Snapshot type", - "name": "type", - "type": "string" - }, - { - "description": "the description of the vm snapshot", - "name": "description", - "type": "string" - }, - { - "description": "the account associated with the disk volume", - "name": "account", - "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 vm name of the vm snapshot", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", - "type": "string" - }, - { - "description": "the ID of the vm snapshot", - "name": "id", - "type": "string" - }, - { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", - "type": "string" - }, - { - "description": "path of the domain to which the disk volume belongs", - "name": "domainpath", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.2.0" @@ -147812,26 +147956,26 @@ "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "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.2.0" }, @@ -147843,31 +147987,31 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the uuid of Tungsten-Fabric tag type", @@ -147879,36 +148023,36 @@ ], "related": "", "response": [ + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric tag type 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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, { "description": "Tungsten-Fabric tag type uuid", "name": "uuid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric tag type name", - "name": "name", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" } ] @@ -147919,19 +148063,19 @@ "name": "extractSnapshot", "params": [ { - "description": "the ID of the zone where the snapshot is located", + "description": "the ID of the snapshot", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "id", + "related": "listSnapshots", "required": true, "since": "4.20.0", "type": "uuid" }, { - "description": "the ID of the snapshot", + "description": "the ID of the zone where the snapshot is located", "length": 255, - "name": "id", - "related": "listSnapshots", + "name": "zoneid", + "related": "listZones", "required": true, "since": "4.20.0", "type": "uuid" @@ -147940,36 +148084,42 @@ "related": "", "response": [ { - "description": "the name of the extracted object", - "name": "name", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, - {}, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, + {}, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "the account id to which the extracted object belongs", + "name": "accountid", + "type": "string" + }, + { + "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", @@ -147981,15 +148131,20 @@ "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": "type of the storage", - "name": "storagetype", + "description": "", + "name": "resultstring", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the status of the extraction", "name": "status", @@ -148001,25 +148156,14 @@ "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 percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the state of the extracted object", + "name": "state", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.20.0" @@ -148030,11 +148174,12 @@ "name": "listSSHKeyPairs", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List by keyword", @@ -148044,94 +148189,93 @@ "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "", + "name": "isrecursive", "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": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "A public key fingerprint to look for", "length": 255, - "name": "account", + "name": "fingerprint", "required": false, "type": "string" }, { - "description": "the ID of the ssh keypair", + "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", - "related": "listSSHKeyPairs", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "A key pair name to look for", + "description": "the ID of the ssh keypair", "length": 255, - "name": "name", + "name": "id", + "related": "listSSHKeyPairs", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "A public key fingerprint to look for", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "fingerprint", + "name": "account", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "A key pair name to look for", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the project name of the keypair owner", - "name": "project", + "description": "Name of the keypair", + "name": "name", "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 domain name of the keypair owner", + "name": "domain", "type": "string" }, - {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", - "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", @@ -148145,8 +148289,8 @@ }, {}, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, { @@ -148155,19 +148299,19 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Name of the keypair", - "name": "name", + "description": "the owner of the keypair", + "name": "account", "type": "string" }, { "description": "Fingerprint of the public key", "name": "fingerprint", "type": "string" + }, + { + "description": "the domain id of the keypair owner", + "name": "domainid", + "type": "string" } ] }, @@ -148188,71 +148332,60 @@ "related": "", "response": [ { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "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", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, + {}, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the tags for the storage pool", + "name": "tags", + "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" }, - {}, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "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": "IOPS CloudStack can provision from this storage pool", @@ -148260,23 +148393,23 @@ "type": "long" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "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 name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { @@ -148285,9 +148418,9 @@ "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { "description": "the state of the storage pool", @@ -148295,59 +148428,70 @@ "type": "storagepoolstatus" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, + {}, + { + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the storage pool type", + "name": "type", "type": "string" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" } ] }, @@ -148364,14 +148508,6 @@ "since": "4.4", "type": "boolean" }, - { - "description": "the ID of the snapshot policy", - "length": 255, - "name": "id", - "related": "updateSnapshotPolicy", - "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, @@ -148379,11 +148515,64 @@ "required": false, "since": "4.4", "type": "string" + }, + { + "description": "the ID of the snapshot policy", + "length": 255, + "name": "id", + "related": "updateSnapshotPolicy", + "required": false, + "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": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, {}, + { + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + { + "description": "the ID of the snapshot policy", + "name": "id", + "type": "string" + }, + { + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, + { + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", @@ -148394,13 +148583,13 @@ "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" }, { @@ -148414,48 +148603,38 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "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": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, - { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" - }, - { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, { "description": "the time zone of the snapshot policy", "name": "timezone", @@ -148466,42 +148645,7 @@ "name": "hasannotations", "type": "boolean" }, - { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {}, - { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, - { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the snapshot policy", - "name": "id", - "type": "string" - } + {} ] }, { @@ -148510,32 +148654,39 @@ "name": "quotaSummary", "params": [ { - "description": "Optional, to list all accounts irrespective of the quota activity", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, + { + "description": "Optional, Account Id for which statement needs to be generated", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "Optional, to list all accounts irrespective of the quota activity", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", @@ -148544,20 +148695,19 @@ "related": "listDomains", "required": false, "type": "uuid" - }, - { - "description": "Optional, Account Id for which statement needs to be generated", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "related": "", "response": [ + {}, { - "description": "account name", - "name": "account", + "description": "start date", + "name": "startdate", + "type": "date" + }, + { + "description": "currency", + "name": "currency", "type": "string" }, { @@ -148565,61 +148715,55 @@ "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "domain id", + "name": "domainid", + "type": "string" + }, + { + "description": "domain name", + "name": "domain", + "type": "string" + }, { "description": "if the account has the quota config enabled", "name": "quotaenabled", "type": "boolean" }, { - "description": "end date", - "name": "enddate", - "type": "date" - }, - {}, - { - "description": "quota usage of this period", - "name": "quota", + "description": "account balance", + "name": "balance", "type": "bigdecimal" }, { - "description": "account id", - "name": "accountid", + "description": "account name", + "name": "account", "type": "string" }, { - "description": "start date", - "name": "startdate", - "type": "date" + "description": "quota usage of this period", + "name": "quota", + "type": "bigdecimal" }, { - "description": "currency", - "name": "currency", - "type": "string" + "description": "end date", + "name": "enddate", + "type": "date" }, - {}, { "description": "account state", "name": "state", "type": "state" }, - { - "description": "domain name", - "name": "domain", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "account balance", - "name": "balance", - "type": "bigdecimal" - }, - { - "description": "domain id", - "name": "domainid", + "description": "account id", + "name": "accountid", "type": "string" } ], @@ -148642,54 +148786,60 @@ "related": "", "response": [ { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", + "type": "long" }, { - "description": "the async command executed", - "name": "cmd", - "type": "string" + "description": " the created date of the job", + "name": "created", + "type": "date" }, - {}, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, + {}, { "description": "the unique ID of the instance/entity object related to the job", "name": "jobinstanceid", "type": "string" }, - { - "description": "the account id that executed the async command", - "name": "accountid", - "type": "string" - }, { "description": "the result type", "name": "jobresulttype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "the current job status-should be 0 for PENDING", "name": "jobstatus", "type": "integer" }, { - "description": "the domain that executed the async command", - "name": "domainpath", + "description": "the account id that executed the async command", + "name": "accountid", "type": "string" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", - "type": "long" + "description": "the user that executed the async command", + "name": "userid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" + }, + { + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" + }, + {}, + { + "description": "the domain id that executed the async command", + "name": "domainid", "type": "string" }, { @@ -148698,20 +148848,25 @@ "type": "string" }, { - "description": "the domain id that executed the async command", - "name": "domainid", + "description": "the async command executed", + "name": "cmd", "type": "string" }, { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + { + "description": "the domain that executed the async command", + "name": "domainpath", + "type": "string" + }, { "description": "the result reason", "name": "jobresult", @@ -148721,17 +148876,6 @@ "description": " the completed date of the job", "name": "completed", "type": "date" - }, - {}, - { - "description": " the created date of the job", - "name": "created", - "type": "date" - }, - { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", - "type": "string" } ] }, @@ -148772,47 +148916,57 @@ "related": "addNetscalerLoadBalancer", "response": [ { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "device name", - "name": "lbdevicename", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "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": "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": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" }, - {}, { "description": "the private interface of the load balancer", "name": "privateinterface", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "device name", + "name": "lbdevicename", "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 id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -148824,19 +148978,19 @@ "type": "boolean" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" }, { "description": "the physical network to which this netscaler device belongs to", @@ -148844,19 +148998,9 @@ "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" - }, - { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "name of the provider", + "name": "provider", "type": "string" - }, - { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" } ] }, @@ -148873,9 +149017,9 @@ "type": "string" }, { - "description": "Name of the counter.", + "description": "Source of the counter.", "length": 255, - "name": "name", + "name": "source", "required": true, "type": "string" }, @@ -148888,9 +149032,9 @@ "type": "string" }, { - "description": "Source of the counter.", + "description": "Name of the counter.", "length": 255, - "name": "source", + "name": "name", "required": true, "type": "string" } @@ -148898,44 +149042,44 @@ "related": "", "response": [ { - "description": "Provider of the counter.", - "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": "Source of the counter.", + "name": "source", + "type": "string" }, + {}, { "description": "Name of the counter.", "name": "name", "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, - {}, { - "description": "Source of the counter.", - "name": "source", + "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": "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", + "description": "the id of the Counter", + "name": "id", "type": "string" }, { - "description": "the id of the Counter", - "name": "id", + "description": "Provider of the counter.", + "name": "provider", "type": "string" }, {} @@ -148948,23 +149092,23 @@ "params": [], "related": "", "response": [ + { + "description": "Event Type", + "name": "name", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - { - "description": "Event Type", - "name": "name", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -148983,38 +149127,38 @@ ], "related": "", "response": [ - {}, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "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": "long" }, - {}, { "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" - }, { "description": "Indicates whether CloudStack is ready to shutdown", "name": "readyforshutdown", "type": "boolean" }, + {}, { - "description": "The id of the management server", - "name": "managementserverid", + "description": "The number of jobs in progress", + "name": "pendingjobscount", "type": "long" - } + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "4.19.0" }, @@ -149023,20 +149167,6 @@ "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, - "type": "string" - }, - { - "description": "the username for the VSM associated with this cluster", - "length": 255, - "name": "vsmusername", - "required": false, - "type": "string" - }, { "description": "the Pod ID for the host", "length": 255, @@ -149046,23 +149176,23 @@ "type": "uuid" }, { - "description": "the cluster name", + "description": "the ipaddress of the VSM associated with this cluster", "length": 255, - "name": "clustername", - "required": true, + "name": "vsmipaddress", + "required": false, "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)", + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "guestvswitchtype", + "name": "publicvswitchname", "required": false, "type": "string" }, { - "description": "the URL", + "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": "url", + "name": "guestvswitchtype", "required": false, "type": "string" }, @@ -149075,10 +149205,17 @@ "type": "uuid" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "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": "clustertype", - "required": true, + "name": "publicvswitchtype", + "required": false, + "type": "string" + }, + { + "description": "the username for the cluster", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { @@ -149089,94 +149226,107 @@ "type": "string" }, { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", + "description": "the password for the VSM associated with this cluster", "length": 255, - "name": "hypervisor", + "name": "vsmpassword", + "required": false, + "type": "string" + }, + { + "description": "type of the cluster: CloudManaged, ExternalManaged", + "length": 255, + "name": "clustertype", "required": true, "type": "string" }, { - "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "guestvswitchname", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "Ovm3 vip to use for pool (and cluster)", + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", "length": 255, - "name": "ovm3vip", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "the username for the cluster", + "description": "the URL", "length": 255, - "name": "username", + "name": "url", "required": false, "type": "string" }, { - "description": "the ipaddress of the VSM associated with this cluster", + "description": "Ovm3 vip to use for pool (and cluster)", "length": 255, - "name": "vsmipaddress", + "name": "ovm3vip", "required": false, "type": "string" }, { - "description": "Ovm3 native pooling enabled for cluster", + "description": "the username for the VSM associated with this cluster", "length": 255, - "name": "ovm3pool", + "name": "vsmusername", "required": false, "type": "string" }, { - "description": "the password for the host", + "description": "Ovm3 native pooling enabled for cluster", "length": 255, - "name": "password", + "name": "ovm3pool", "required": false, "type": "string" }, { - "description": "the password for the VSM associated with this cluster", + "description": "the cluster name", "length": 255, - "name": "vsmpassword", - "required": false, + "name": "clustername", + "required": true, "type": "string" }, { - "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": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "publicvswitchtype", + "name": "guestvswitchname", "required": false, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the password for the host", "length": 255, - "name": "allocationstate", + "name": "password", "required": false, "type": "string" }, { - "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", "length": 255, - "name": "arch", - "required": false, - "since": "4.20", + "name": "hypervisor", + "required": true, "type": "string" } ], "related": "", "response": [ { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, + {}, { - "description": "the cluster ID", - "name": "id", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { @@ -149190,51 +149340,30 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "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": "Ovm3 VIP to use for pooling and/or clustering", "name": "ovm3vip", "type": "string" }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - {}, { "description": "the Zone ID of the cluster", "name": "zoneid", "type": "string" }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, { "description": "Meta data associated with the zone (key/value pairs)", "name": "resourcedetails", @@ -149245,19 +149374,43 @@ "name": "managedstate", "type": "string" }, - {}, + { + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "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 total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -149266,8 +149419,8 @@ "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { @@ -149276,14 +149429,9 @@ "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { "description": "the Pod ID", @@ -149291,8 +149439,8 @@ "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { @@ -149301,36 +149449,32 @@ "type": "long" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Pod name", + "name": "podname", + "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", "type": "string" } ], "type": "list" }, + {}, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - { - "description": "the cluster name", - "name": "name", + "description": "the cluster ID", + "name": "id", "type": "string" } ] @@ -149341,223 +149485,81 @@ "name": "deleteTrafficMonitor", "params": [ { - "description": "Id of the Traffic Monitor Host.", - "length": 255, - "name": "id", - "related": "reconnectHost", - "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": "Removes VM from specified network by deleting a NIC", - "isasync": true, - "name": "removeNicFromVirtualMachine", - "params": [ - { - "description": "Virtual Machine ID", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "NIC ID", - "length": 255, - "name": "nicid", - "related": "", - "required": true, - "type": "uuid" - } - ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "response": [ - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "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": "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 name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the list of resource tags associated", - "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 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": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "Id of the Traffic Monitor Host.", + "length": 255, + "name": "id", + "related": "reconnectHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Removes VM from specified network by deleting a NIC", + "isasync": true, + "name": "removeNicFromVirtualMachine", + "params": [ + { + "description": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "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": "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 ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { @@ -149570,116 +149572,121 @@ "name": "securitygroup", "response": [ { - "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 list of ingress rules associated with the security group", - "name": "ingressrule", + "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": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "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 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 account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "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", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 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" + "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": "security group name", "name": "securitygroupname", @@ -149689,17 +149696,27 @@ "type": "set" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "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", + "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -149707,48 +149724,48 @@ "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 domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "tag value", - "name": "value", + "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -149757,59 +149774,54 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "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 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 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", + "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" } ], "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -149818,42 +149830,37 @@ "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the name of the security group", + "name": "name", "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 domain ID of the security group", - "name": "domainid", + "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 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", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -149862,13 +149869,13 @@ "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 id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -149877,236 +149884,197 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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 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 ID of the security group", + "name": "id", + "type": "string" } ], "type": "set" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "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 name of the affinity group", + "name": "name", "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": "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "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": "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "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 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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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 name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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", + "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 group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "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 ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -150115,63 +150083,88 @@ "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", "type": "map" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "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 pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", "type": "string" }, { @@ -150180,13 +150173,38 @@ "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the account associated with the virtual machine", + "name": "account", "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 name of the vm", + "name": "project", + "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 user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "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" }, { @@ -150195,110 +150213,84 @@ "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "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": "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 name of the affinity group", - "name": "name", - "type": "string" - }, - { - "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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "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 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": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + {}, + { + "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": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { @@ -150307,101 +150299,250 @@ "type": "string" }, { - "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "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 read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, - {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "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 ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "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 traffic type of the nic", + "name": "traffictype", + "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 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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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 gateway of IPv6 network", + "name": "ip6gateway", + "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": "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 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 vpc to which the nic belongs", + "name": "vpcid", + "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "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": "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 ID of the corresponding network", + "name": "networkid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "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 name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, { "description": "the control state of the host for the virtual machine", "name": "hostcontrolstate", "type": "string" }, - {}, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { @@ -150410,58 +150551,70 @@ "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 userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "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": "the name of the host for the virtual machine", - "name": "hostname", - "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": "the list of resource tags associated", + "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": "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": "resource type", + "name": "resourcetype", + "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": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -150470,25 +150623,16 @@ "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -150496,13 +150640,6 @@ "isasync": false, "name": "listDedicatedHosts", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the ID of the domain associated with the host", "length": 255, @@ -150511,6 +150648,13 @@ "required": false, "type": "uuid" }, + { + "description": "the name of the account associated with the host. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "List by keyword", "length": 255, @@ -150519,11 +150663,11 @@ "type": "string" }, { - "description": "the name of the account associated with the host. Must be used with domainId.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "list dedicated hosts by affinity group", @@ -150534,109 +150678,66 @@ "type": "uuid" }, { - "description": "the ID of the host", + "description": "", "length": 255, - "name": "hostid", - "related": "reconnectHost", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "the ID of the host", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "reconnectHost", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the domain ID of the host", - "name": "domainid", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { - "description": "the Account ID of the host", - "name": "accountid", + "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 host", - "name": "hostid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the ID of the dedicated resource", "name": "id", "type": "string" }, + {}, { "description": "the Dedication Affinity Group ID of the host", "name": "affinitygroupid", "type": "string" }, + {}, { - "description": "the name of the host", - "name": "hostname", + "description": "the domain ID of the host", + "name": "domainid", "type": "string" - } - ] - }, - { - "description": "Get diagnostics and files from system VMs", - "isasync": true, - "name": "getDiagnosticsData", - "params": [ - { - "description": "The ID of the system VM instance to retrieve diagnostics data files from", - "length": 255, - "name": "targetid", - "related": "", - "required": true, - "type": "uuid" }, { - "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" - } - ], - "related": "", - "response": [ - { - "description": "Storage URL to download retrieve diagnostics data files", - "name": "url", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } - ], - "since": "4.14.0.0" + ] }, { "description": "upload an existing ISO into the CloudStack cloud.", @@ -150644,46 +150745,37 @@ "name": "getUploadParamsForIso", "params": [ { - "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 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": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "checksum", + "name": "account", "required": false, "type": "string" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "the name of the volume/template/iso", "length": 255, - "name": "format", + "name": "name", "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", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "ostypeid", - "related": "", + "name": "ispublic", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Upload volume/template/iso for the project", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "projectid", - "related": "", + "name": "isextractable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "true if you want this ISO to be featured", "length": 255, - "name": "isextractable", + "name": "isfeatured", "required": false, "type": "boolean" }, @@ -150695,105 +150787,149 @@ "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "account", - "required": false, + "name": "format", + "required": true, "type": "string" }, { - "description": "the name of the volume/template/iso", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, + "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": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "bootable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "true if you want this ISO to be featured", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "isfeatured", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "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": "bootable", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the timestamp after which the signature expires", "name": "expires", "type": "string" }, - { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" - }, { "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "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 template/volume ID", + "name": "id", + "type": "uuid" + }, + {} + ], + "since": "4.13" + }, + { + "description": "Get diagnostics and files from system VMs", + "isasync": true, + "name": "getDiagnosticsData", + "params": [ + { + "description": "The ID of the system VM instance to retrieve diagnostics data files from", + "length": 255, + "name": "targetid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "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" + } + ], + "related": "", + "response": [ {}, + { + "description": "Storage URL to download retrieve diagnostics data files", + "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" } ], - "since": "4.13" + "since": "4.14.0.0" }, { "description": "Deletes a autoscale vm group.", "isasync": true, "name": "deleteAutoScaleVmGroup", "params": [ - { - "description": "true if all VMs have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.18.0", - "type": "boolean" - }, { "description": "the ID of the autoscale group", "length": 255, @@ -150801,13 +150937,21 @@ "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 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" }, {}, { @@ -150816,15 +150960,15 @@ "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" } ] }, @@ -150834,17 +150978,16 @@ "name": "listPaloAltoFirewalls", "params": [ { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -150857,68 +151000,73 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "the Physical Network ID", "length": 255, - "name": "keyword", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "device name", - "name": "fwdevicename", + "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 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 public security zone of the external firewall", + "name": "publiczone", + "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "name of the provider", - "name": "provider", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, - {}, { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the number of times to retry requests to the external firewall", @@ -150926,43 +151074,39 @@ "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "device name", + "name": "fwdevicename", "type": "string" }, + {}, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, - { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "name of the provider", + "name": "provider", "type": "string" } ] @@ -150979,6 +151123,14 @@ "required": false, "type": "string" }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, { "description": "the description of the load balancer rule", "length": 4096, @@ -150987,18 +151139,17 @@ "type": "string" }, { - "description": "The protocol for the LB", + "description": "the name of the load balancer rule", "length": 255, - "name": "protocol", + "name": "name", "required": false, "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The protocol for the LB", "length": 255, - "name": "customid", + "name": "protocol", "required": false, - "since": "4.4", "type": "string" }, { @@ -151016,13 +151167,6 @@ "required": false, "since": "4.4", "type": "boolean" - }, - { - "description": "the name of the load balancer rule", - "length": 255, - "name": "name", - "required": false, - "type": "string" } ], "related": "listLoadBalancerRules", @@ -151034,44 +151178,8 @@ "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 protocol of the loadbalanacer rule", - "name": "protocol", - "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 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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { @@ -151080,54 +151188,14 @@ "type": "boolean" }, { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "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 network the lb rule belongs to", @@ -151135,13 +151203,13 @@ "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -151149,13 +151217,13 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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" }, { @@ -151164,8 +151232,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -151174,37 +151242,113 @@ "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 domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "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 load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, + { + "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 name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" } ] }, @@ -151213,13 +151357,6 @@ "isasync": false, "name": "enableAccount", "params": [ - { - "description": "Enables specified account.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "Account id", "length": 255, @@ -151235,86 +151372,143 @@ "related": "listDomains", "required": false, "type": "uuid" + }, + { + "description": "Enables specified account.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "listAccounts", "response": [ { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the list of acl groups that account belongs to", "name": "groups", "type": "list" }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, {}, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, {}, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "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 stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "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": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" }, { "description": "the total volume which can be used by this account", @@ -151322,93 +151516,133 @@ "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, + { + "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 total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "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", + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "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 cpu cores owned by account", "name": "cputotal", "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { "description": "the ID of the role", @@ -151416,8 +151650,13 @@ "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -151426,49 +151665,59 @@ "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "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 api key of the user", - "name": "apikey", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the user email address", + "name": "email", + "type": "string" }, { "description": "the account name of the user", @@ -151481,137 +151730,62 @@ "type": "date" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user state", - "name": "state", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the user ID", + "name": "id", "type": "string" } ], "type": "list" }, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "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 secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "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 projects the account can own", - "name": "projectlimit", - "type": "string" - }, { "description": "the state of the account", "name": "state", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, { "description": "the total secondary storage space (in GiB) the account can own", "name": "secondarystoragelimit", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { "description": "Base64 string representation of the resource icon", @@ -151619,59 +151793,29 @@ "type": "resourceiconresponse" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "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", + "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 snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "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 account", + "name": "primarystoragetotal", + "type": "long" }, { "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", "name": "roletype", "type": "string" - }, - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" } ] }, @@ -151680,13 +151824,6 @@ "isasync": true, "name": "changeStoragePoolScope", "params": [ - { - "description": "the scope of the storage: cluster or zone", - "length": 255, - "name": "scope", - "required": true, - "type": "string" - }, { "description": "the Id of the cluster to use if scope is being set to Cluster", "length": 255, @@ -151695,6 +151832,13 @@ "required": false, "type": "uuid" }, + { + "description": "the scope of the storage: cluster or zone", + "length": 255, + "name": "scope", + "required": true, + "type": "string" + }, { "description": "the Id of the storage pool", "length": 255, @@ -151705,18 +151849,13 @@ } ], "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", @@ -151726,6 +151865,11 @@ "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.1" @@ -151735,6 +151879,13 @@ "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": "the ID of the network", "length": 255, @@ -151742,37 +151893,30 @@ "related": "createNetwork,updateNetwork,listNetworks", "required": true, "type": "uuid" - }, - { - "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" } ], "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": "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" } ] }, @@ -151793,28 +151937,28 @@ "related": "", "response": [ { - "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 last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "events available for the host", - "name": "events", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { @@ -151823,168 +151967,223 @@ "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, + {}, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "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 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": "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": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "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 host hypervisor", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "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": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the host version", - "name": "version", + "description": "the OS category ID of the host", + "name": "oscategoryid", "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": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { @@ -151993,23 +152192,13 @@ "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { @@ -152017,36 +152206,30 @@ "name": "disksizeallocated", "type": "long" }, - {}, - { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" - }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { "description": "the Pod name of the host", @@ -152054,103 +152237,49 @@ "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the host", + "name": "name", + "type": "string" }, - {}, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, + {}, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "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": "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": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { @@ -152159,13 +152288,8 @@ "type": "boolean" }, { - "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", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { @@ -152174,14 +152298,34 @@ "type": "date" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "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 IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the host type", + "name": "type", + "type": "type" } ] }, @@ -152202,8 +152346,8 @@ "related": "", "response": [ { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { @@ -152212,58 +152356,53 @@ "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "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 Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "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 name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "name": "zoneid", "type": "string" }, { @@ -152272,50 +152411,39 @@ "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - }, - { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, - { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "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 name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, { "description": "the ID of the template of the Kubernetes cluster", @@ -152323,24 +152451,29 @@ "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "keypair details", - "name": "keypair", + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { @@ -152349,30 +152482,31 @@ "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, + {}, { "description": "path of the domain to which the Kubernetes cluster belongs", "name": "domainpath", @@ -152384,14 +152518,24 @@ "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "keypair details", + "name": "keypair", + "type": "string" + }, + { + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" + }, + { + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", "type": "long" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" } ] }, @@ -152400,14 +152544,6 @@ "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, @@ -152415,31 +152551,39 @@ "related": "", "required": true, "type": "uuid" + }, + { + "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" } ], "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": "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": "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" }, @@ -152472,22 +152616,22 @@ ], "related": "", "response": [ + {}, { "description": "the name of the shared filesystem provider", "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", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.20.0" @@ -152509,41 +152653,41 @@ "related": "listTemplatePermissions,listIsoPermissions", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the list of projects the template is available for", - "name": "projectids", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {}, { "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": "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 template ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "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" } ] }, @@ -152553,12 +152697,19 @@ "name": "addNetscalerLoadBalancer", "params": [ { - "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", + "description": "URL of the netscaler load balancer appliance.", "length": 255, - "name": "networkdevicetype", + "name": "url", "required": true, "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, + "type": "boolean" + }, { "description": "public IP of the site", "length": 255, @@ -152567,17 +152718,18 @@ "type": "string" }, { - "description": "URL of the netscaler load balancer appliance.", + "description": "the Physical Network ID", "length": 255, - "name": "url", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "private IP of the site", + "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "gslbproviderprivateip", - "required": false, + "name": "username", + "required": true, "type": "string" }, { @@ -152590,86 +152742,77 @@ { "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "Credentials to reach netscaler load balancer device", + "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", "length": 255, - "name": "password", + "name": "networkdevicetype", "required": true, "type": "string" }, { - "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", + "description": "private IP of the site", "length": 255, - "name": "isexclusivegslbprovider", + "name": "gslbproviderprivateip", "required": false, - "type": "boolean" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" - }, - { - "description": "device name", - "name": "lbdevicename", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, - {}, - {}, { "description": "true if device is dedicated for an account", "name": "lbdevicededicated", "type": "boolean" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + {}, + { + "description": "device state", + "name": "lbdevicestate", "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": "true if NetScaler device is provisioned to be a GSLB service provider", @@ -152677,34 +152820,35 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, + {}, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the public interface of the load balancer", + "name": "publicinterface", "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": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "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 management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" } ] }, @@ -152721,6 +152865,13 @@ "required": false, "type": "list" }, + { + "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": "the network ID", "length": 255, @@ -152736,16 +152887,14 @@ "related": "", "required": false, "type": "list" - }, - { - "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" } ], "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", @@ -152762,11 +152911,6 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {} ], "since": "4.17.0" @@ -152799,21 +152943,21 @@ "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} ] @@ -152831,11 +152975,12 @@ "type": "string" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { "description": "Pxe server device ID", @@ -152852,29 +152997,23 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "device id of ", - "name": "id", + "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 physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "device id of ", + "name": "id", "type": "string" }, { @@ -152882,6 +153021,12 @@ "name": "provider", "type": "string" }, + { + "description": "url", + "name": "url", + "type": "string" + }, + {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -152889,11 +153034,10 @@ "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" + } ] }, { @@ -152912,33 +153056,23 @@ "related": "", "response": [ { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the api key of the user", - "name": "apikey", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -152947,100 +153081,110 @@ "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": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the user ID", + "name": "id", "type": "string" }, { - "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": "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 email address", - "name": "email", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { "description": "the account ID of the user", "name": "accountid", "type": "string" }, - {}, { - "description": "the type of the role", - "name": "roletype", + "description": "the ID of the role", + "name": "roleid", "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": "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 domain name of the user", - "name": "domain", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the user ID", - "name": "id", + "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + {}, { - "description": "the name of the role", - "name": "rolename", + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" } ] @@ -153059,32 +153203,41 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list by network ID the rule belongs to", "length": 255, - "name": "isrecursive", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "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": "list by network ID the rule belongs to", + "description": "the ID of the virtual machine of the load balancer rule", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "virtualmachineid", + "related": "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": "the ID of the load balancer rule", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, @@ -153096,64 +153249,54 @@ "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "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, - "since": "4.4", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the virtual machine of the load balancer rule", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the name of the load balancer rule", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the availability zone ID", + "description": "the ID of the load balancer rule", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "id", + "related": "", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the name of the load balancer rule", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "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": "list objects by project; if projectid=-1 lists All VMs", @@ -153164,42 +153307,109 @@ "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 availability zone ID", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "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 load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, { "description": "the list of resource tags associated with 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", + "description": "the account associated with the tag", + "name": "account", "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": "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" }, { @@ -153208,8 +153418,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -153218,88 +153428,51 @@ "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", - "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 domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "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 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 load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the private port", + "name": "privateport", "type": "string" }, { @@ -153308,48 +153481,19 @@ "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", + "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" - }, + {}, { "description": "the state of the rule", "name": "state", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the project name of the load balancer", + "name": "project", "type": "string" } ] @@ -153359,6 +153503,13 @@ "isasync": true, "name": "createManagementNetworkIpRange", "params": [ + { + "description": "Specify if range is dedicated for CPVM and SSVM.", + "length": 255, + "name": "forsystemvms", + "required": false, + "type": "boolean" + }, { "description": "The netmask for the management network.", "length": 255, @@ -153367,10 +153518,10 @@ "type": "string" }, { - "description": "The ending IP address.", + "description": "The starting IP address.", "length": 255, - "name": "endip", - "required": false, + "name": "startip", + "required": true, "type": "string" }, { @@ -153387,20 +153538,6 @@ "required": false, "type": "string" }, - { - "description": "Specify if range is dedicated for CPVM and SSVM.", - "length": 255, - "name": "forsystemvms", - "required": false, - "type": "boolean" - }, - { - "description": "The starting IP address.", - "length": 255, - "name": "startip", - "required": true, - "type": "string" - }, { "description": "UUID of POD, where the IP range belongs to.", "length": 255, @@ -153408,148 +153545,90 @@ "related": "createManagementNetworkIpRange", "required": true, "type": "uuid" + }, + { + "description": "The ending IP address.", + "length": 255, + "name": "endip", + "required": false, + "type": "string" } ], "related": "", "response": [ - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, { "description": "the IP ranges for the Pod", "name": "ipranges", "response": [ { - "description": "the ending IP for the range", - "name": "endip", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the gateway for the range", - "name": "gateway", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" } ], "type": "list" }, + {}, { "description": "the Zone ID of the Pod", "name": "zoneid", "type": "string" }, - { - "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 Zone name of the Pod", - "name": "zonename", - "type": "string" - }, - { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" - }, - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "indicates Vlan ID for the range. 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 allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, {}, - { - "description": "the ID of the Pod", - "name": "id", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" }, { "description": "the capacity of the Pod", "name": "capacity", "response": [ { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity name", - "name": "name", + "description": "the percentage of capacity currently in use", + "name": "percentused", "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 Zone name", "name": "zonename", @@ -153561,13 +153640,13 @@ "type": "long" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Zone ID", + "name": "zoneid", + "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { @@ -153576,22 +153655,87 @@ "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" } ], "type": "list" + }, + { + "description": "the ID of the Pod", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the Pod", + "name": "name", + "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 netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "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 ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" } ], "since": "4.11.0.0" @@ -153604,22 +153748,14 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "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": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -153630,6 +153766,14 @@ "required": false, "type": "string" }, + { + "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": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, @@ -153642,29 +153786,24 @@ "related": "", "response": [ { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, + {}, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" - }, - { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" }, - {}, { - "description": "device name", - "name": "vsmdevicename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -153673,44 +153812,49 @@ "type": "int" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", - "type": "string" - }, - { - "description": "device state", - "name": "vsmdevicestate", - "type": "string" - }, - { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", - "type": "string" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" + }, { "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 VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "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 management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" } ] @@ -153720,6 +153864,13 @@ "isasync": true, "name": "addVpnUser", "params": [ + { + "description": "an optional account for the vpn user. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "add vpn user to the specific project", "length": 255, @@ -153735,13 +153886,6 @@ "required": true, "type": "string" }, - { - "description": "an optional account for the vpn user. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, @@ -153765,30 +153909,19 @@ "name": "state", "type": "string" }, - { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" - }, - { - "description": "the vpn userID", - "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", + "description": "the vpn userID", + "name": "id", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { @@ -153796,27 +153929,38 @@ "name": "domainid", "type": "string" }, + {}, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, + {}, { "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 username of the vpn user", "name": "username", "type": "string" }, + { + "description": "the account of the remote access vpn", + "name": "account", + "type": "string" + }, { "description": "the project id of the vpn", "name": "projectid", "type": "string" - }, - {} + } ] }, { @@ -153842,17 +153986,12 @@ } ], "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", @@ -153860,9 +153999,14 @@ "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.15.0" @@ -153898,9 +154042,19 @@ "related": "", "response": [ { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", + "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" }, { "description": "End date for the quarantine.", @@ -153908,51 +154062,41 @@ "type": "date" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, {}, - { - "description": "ID of the quarantine process.", - "name": "id", - "type": "string" - }, + {}, { "description": "When the quarantine was removed.", "name": "removed", "type": "date" }, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", - "type": "string" - }, - { - "description": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "ID of the quarantine process.", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "When the quarantine was created.", + "name": "created", + "type": "date" } ], "since": "4.19" @@ -153963,35 +154107,27 @@ "name": "updateVnfTemplate", "params": [ { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "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": "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": "vnfnics", + "name": "vnfdetails", "required": false, "type": "map" }, - { - "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 ID of the image file", "length": 255, "name": "id", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, + { + "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": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, @@ -154000,39 +154136,39 @@ "type": "boolean" }, { - "description": "the format for the image", + "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", "length": 255, - "name": "format", + "name": "cleanupvnfnics", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "templatetype", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", + "description": "sort key of the template, integer", "length": 255, - "name": "cleanupvnfnics", + "name": "sortkey", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", "length": 255, - "name": "isdynamicallyscalable", + "name": "cleanupvnfdetails", "required": false, "type": "boolean" }, { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "the name of the image file", "length": 255, - "name": "arch", + "name": "name", "required": false, - "since": "4.20", "type": "string" }, { @@ -154043,127 +154179,141 @@ "type": "string" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "details", + "name": "sshkeyenabled", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", + "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": "cleanupvnfdetails", + "name": "cleanupdetails", "required": false, "type": "boolean" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "the ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "passwordenabled", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the tag for this template.", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "templatetag", + "name": "bootable", "required": false, - "since": "4.20.0", - "type": "string" + "type": "boolean" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "bootable", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "sort key of the template, integer", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "sortkey", + "name": "requireshvm", "required": false, - "type": "integer" + "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": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "cleanupdetails", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "the name of the image file", + "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": "name", + "name": "vnfnics", "required": false, - "type": "string" + "type": "map" }, { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "vnfdetails", + "name": "details", "required": false, "type": "map" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "the tag for this template.", "length": 255, - "name": "requireshvm", + "name": "templatetag", "required": false, - "type": "boolean" + "since": "4.20.0", + "type": "string" + }, + { + "description": "the format for the image", + "length": 255, + "name": "format", + "required": false, + "type": "string" } ], - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", "response": [ { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the project id of the template", + "name": "projectid", "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" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "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": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, + {}, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { @@ -154172,130 +154322,155 @@ "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "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 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": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "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" }, { - "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 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" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "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": "checksum of the template", - "name": "checksum", - "type": "string" - }, { "description": "the processor bit size", "name": "bits", "type": "int" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { @@ -154304,18 +154479,23 @@ "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", - "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": "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 userdata linked to this template", - "name": "userdataname", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { @@ -154323,21 +154503,20 @@ "name": "childtemplates", "type": "set" }, - {}, { - "description": "the template display text", - "name": "displaytext", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "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", @@ -154345,115 +154524,80 @@ "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 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 ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the tag of this template", - "name": "templatetag", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", + "description": "the date this template was created", + "name": "created", "type": "date" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "the template name", - "name": "name", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the name of the zone for this template", + "name": "zonename", + "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", + "name": "templatetype", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, + {}, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "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", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the size of the template", - "name": "size", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "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": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" } ], "since": "4.19.0" @@ -154463,13 +154607,6 @@ "isasync": true, "name": "updateVPCOffering", "params": [ - { - "description": "sort key of the VPC offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, { "description": "the display text of the VPC offering", "length": 255, @@ -154478,16 +154615,16 @@ "type": "string" }, { - "description": "the name of the VPC offering", + "description": "sort key of the VPC offering, integer", "length": 255, - "name": "name", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { - "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "description": "the name of the VPC offering", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, @@ -154500,9 +154637,9 @@ "type": "uuid" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", + "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "length": 255, + "name": "state", "required": false, "type": "string" }, @@ -154513,18 +154650,41 @@ "required": false, "since": "4.13", "type": "string" + }, + { + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "true if vpc offering can be used by NSX networks only", - "name": "fornsx", + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" + }, + { + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "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": "true if vpc offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "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 vpc offering", + "name": "name", "type": "string" }, { @@ -154533,13 +154693,18 @@ "type": "string" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "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 vpc offering is default, false otherwise", - "name": "isdefault", + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" + }, + { + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", "type": "boolean" }, { @@ -154548,34 +154713,33 @@ "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": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", + "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", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "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 name of the vpc offering", - "name": "name", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { @@ -154584,10 +154748,16 @@ "type": "string" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the list of supported services", "name": "service", @@ -154596,6 +154766,11 @@ "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", @@ -154605,38 +154780,28 @@ "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": "uuid of the network provider", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "state of the network provider", + "name": "state", "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 destination physical network", @@ -154644,14 +154809,14 @@ "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "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 provider name", @@ -154660,35 +154825,14 @@ } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "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": "indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" - }, - { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" } ] }, @@ -154707,28 +154851,28 @@ ], "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", + "type": "string" + }, { "description": "the user two factor authenticator provider name", "name": "name", "type": "string" }, + {}, { - "description": "the description of the user two factor authenticator provider", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.18.0" }, @@ -154738,35 +154882,35 @@ "name": "scaleVirtualMachine", "params": [ { - "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "automigrate", + "name": "details", "required": false, - "since": "4.17", - "type": "boolean" + "type": "map" }, { - "description": "Verify OK to Shrink", + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, - "name": "shrinkok", + "name": "automigrate", "required": false, "since": "4.17", "type": "boolean" }, { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "New minimum number of IOPS for the custom disk offering", "length": 255, - "name": "details", + "name": "miniops", "required": false, - "type": "map" + "since": "4.17", + "type": "long" }, { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "Verify OK to Shrink", "length": 255, - "name": "maxiops", + "name": "shrinkok", "required": false, "since": "4.17", - "type": "long" + "type": "boolean" }, { "description": "the ID of the service offering for the virtual machine", @@ -154780,14 +154924,14 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "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": "New minimum number of IOPS for the custom disk offering", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "miniops", + "name": "maxiops", "required": false, "since": "4.17", "type": "long" @@ -154795,16 +154939,11 @@ ], "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", @@ -154812,9 +154951,14 @@ "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" } ] }, @@ -154851,19 +154995,19 @@ "related": "", "response": [ { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { - "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 network id of the firewall rule", @@ -154875,85 +155019,108 @@ "name": "cidrlist", "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": "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": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "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 id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "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" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, - {}, { "description": "the state of the rule", "name": "state", @@ -154969,31 +155136,8 @@ "name": "endport", "type": "integer" }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" - } + {}, + {} ], "since": "4.4" }, @@ -155003,19 +155147,19 @@ "name": "listOsCategories", "params": [ { - "description": "list Os category by id", + "description": "", "length": 255, - "name": "id", - "related": "listOsCategories", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "list os category by name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "since": "3.0.1", + "type": "string" }, { "description": "", @@ -155025,45 +155169,45 @@ "type": "integer" }, { - "description": "list os category by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, - "since": "3.0.1", "type": "string" }, { - "description": "List by keyword", + "description": "list Os category by id", "length": 255, - "name": "keyword", + "name": "id", + "related": "listOsCategories", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ - { - "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": "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 ID of the OS category", "name": "id", "type": "string" }, {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -155072,11 +155216,12 @@ "name": "listServiceOfferings", "params": [ { - "description": "name of the service offering", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "name", + "name": "projectid", + "related": "", "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.", @@ -155086,12 +155231,19 @@ "type": "boolean" }, { - "description": "listed offerings support root disk encryption", + "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", "length": 255, - "name": "encryptroot", + "name": "systemvmtype", "required": false, - "since": "4.18", - "type": "boolean" + "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": "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": "ID of the service offering", @@ -155102,113 +155254,96 @@ "type": "uuid" }, { - "description": "the CPU number that listed offerings must support", + "description": "List by keyword", "length": 255, - "name": "cpunumber", + "name": "keyword", "required": false, - "since": "4.15", - "type": "integer" + "type": "string" }, { - "description": "The ID of the template that listed offerings must support", + "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "state", "required": false, - "since": "4.20.0", - "type": "uuid" + "since": "4.19", + "type": "string" }, { - "description": "id of zone disk offering is associated with", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "account", "required": false, - "since": "4.13", - "type": "uuid" + "type": "string" }, { - "description": "is this a system vm offering", + "description": "the CPU number that listed offerings must support", "length": 255, - "name": "issystem", + "name": "cpunumber", "required": false, - "type": "boolean" + "since": "4.15", + "type": "integer" }, { - "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": "listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", + "description": "name of the service offering", "length": 255, - "name": "systemvmtype", + "name": "name", "required": false, "type": "string" }, { - "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "state", + "name": "storagetype", "required": false, "since": "4.19", "type": "string" }, { - "description": "the CPU speed that listed offerings must support", - "length": 255, - "name": "cpuspeed", - "required": false, - "since": "4.15", - "type": "integer" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "id of zone disk offering is associated with", "length": 255, - "name": "projectid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "is this a system vm offering", "length": 255, - "name": "keyword", + "name": "issystem", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "storagetype", - "required": false, - "since": "4.19", - "type": "string" + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the CPU speed that listed offerings must support", "length": 255, - "name": "account", + "name": "cpuspeed", "required": false, - "type": "string" + "since": "4.15", + "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": "the RAM memory that listed offering must support", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "memory", "required": false, - "type": "uuid" + "since": "4.15", + "type": "integer" }, { "description": "", @@ -155218,92 +155353,71 @@ "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "The ID of the template that listed offerings must support", "length": 255, - "name": "isrecursive", + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "required": false, + "since": "4.20.0", + "type": "uuid" + }, + { + "description": "listed offerings support root disk encryption", + "length": 255, + "name": "encryptroot", "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "the RAM memory that listed offering must support", + "description": "", "length": 255, - "name": "memory", + "name": "page", "required": false, - "since": "4.15", "type": "integer" } ], "related": "updateServiceOffering", "response": [ { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" - }, - { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", "type": "integer" }, + {}, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" - }, - { - "description": "the name of the service offering", - "name": "name", - "type": "string" - }, - { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" }, - {}, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "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": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { @@ -155312,28 +155426,33 @@ "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", + "description": "the ha support in the service offering", + "name": "offerha", "type": "boolean" }, { - "description": "the number of CPU", - "name": "cpunumber", + "description": "the memory in MB", + "name": "memory", "type": "integer" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the name of the service offering", + "name": "name", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { @@ -155342,19 +155461,24 @@ "type": "long" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "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": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "state of the service offering", - "name": "state", - "type": "string" + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, { "description": "io requests write rate of the service offering", @@ -155362,55 +155486,65 @@ "type": "long" }, { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", "type": "boolean" }, - {}, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "the storage type for this service offering", - "name": "storagetype", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "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": "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 display text of the disk offering", "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "state of the service offering", + "name": "state", "type": "string" }, + {}, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { "description": "is this a default system vm offering", @@ -155418,99 +155552,109 @@ "type": "boolean" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "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": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" + }, + { + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "the date this service 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": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "the memory in MB", - "name": "memory", + "description": "the number of CPU", + "name": "cpunumber", "type": "integer" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "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": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "the tags for the service offering", + "name": "storagetags", + "type": "string" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", - "type": "boolean" + "description": "the host tag for the service offering", + "name": "hosttags", + "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the id of the service offering", + "name": "id", + "type": "string" + }, + { + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" } ] }, @@ -155520,78 +155664,85 @@ "name": "importVm", "params": [ { - "description": "hypervisor type of the host", + "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", "length": 255, - "name": "hypervisor", - "required": true, + "name": "clustername", + "required": false, "type": "string" }, { - "description": "path of the disk image", + "description": "the password for the host", "length": 255, - "name": "diskpath", + "name": "password", "required": false, "type": "string" }, { - "description": "the username for the host", + "description": "Temp Path on external host for disk image copy", "length": 255, - "name": "username", + "name": "temppath", "required": false, "type": "string" }, { - "description": "the zone ID", + "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "existingvcenterid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", + "description": "the network ID", "length": 255, - "name": "convertinstancepoolid", - "related": "", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, "type": "uuid" }, { - "description": "Shared storage pool where disk is located", + "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", "length": 255, - "name": "storageid", - "related": "", + "name": "hostip", "required": false, + "type": "string" + }, + { + "description": "the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering", + "required": true, "type": "uuid" }, { - "description": "VM nic to network id mapping using keys nic and network", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "nicnetworklist", + "name": "datadiskofferinglist", "required": false, "type": "map" }, { - "description": "import instance for the project", + "description": "the display name of the instance", "length": 255, - "name": "projectid", - "related": "", + "name": "displayname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "clustername", + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) optional - if true, forces MS to import VM file(s) to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not.", + "description": "used to specify the custom parameters.", "length": 255, - "name": "forcemstoimportvmfiles", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { "description": "VM nic to ip address mapping using keys nic, ip4Address", @@ -155600,13 +155751,6 @@ "required": false, "type": "map" }, - { - "description": "Source location for Import", - "length": 255, - "name": "importsource", - "required": true, - "type": "string" - }, { "description": "the host name of the instance", "length": 255, @@ -155614,29 +155758,6 @@ "required": false, "type": "string" }, - { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", - "length": 255, - "name": "datadiskofferinglist", - "required": false, - "type": "map" - }, - { - "description": "the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" - }, - { - "description": "the network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": false, - "type": "uuid" - }, { "description": "the cluster ID", "length": 255, @@ -155646,19 +155767,26 @@ "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", + "description": "hypervisor type of the host", "length": 255, - "name": "datacentername", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "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": "(only for importing VMs from VMware to KVM) optional - if true, forces MS to import VM file(s) to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not.", "length": 255, - "name": "forced", + "name": "forcemstoimportvmfiles", "required": false, "type": "boolean" }, + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "Host where local disk is located", "length": 255, @@ -155668,11 +155796,18 @@ "type": "uuid" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "migrateallowed", + "name": "nicnetworklist", "required": false, - "type": "boolean" + "type": "map" + }, + { + "description": "the username for the host", + "length": 255, + "name": "username", + "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.", @@ -155682,168 +155817,609 @@ "type": "string" }, { - "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", + "description": "Shared storage pool where disk is located", "length": 255, - "name": "existingvcenterid", + "name": "storageid", "related": "", "required": false, "type": "uuid" }, { - "description": "the host name or IP address", + "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": "host", + "name": "migrateallowed", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v migration from VMware to KVM.", + "description": "import instance for the project", "length": 255, - "name": "convertinstancehostid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "the name of the instance as it is known to the hypervisor", + "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": "name", - "required": true, - "type": "string" + "name": "convertinstancepoolid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "import instance to the domain specified", + "description": "the zone ID", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "Temp Path on external host for disk image copy", + "description": "the name of the instance as it is known to the hypervisor", "length": 255, - "name": "temppath", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", + "description": "Source location for Import", "length": 255, - "name": "hostip", - "required": false, + "name": "importsource", + "required": true, "type": "string" }, { - "description": "used to specify the custom parameters.", + "description": "path of the disk image", "length": 255, - "name": "details", + "name": "diskpath", "required": false, - "type": "map" + "type": "string" }, { - "description": "the display name of the instance", + "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": "displayname", + "name": "forced", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "the host name or IP address", "length": 255, - "name": "account", + "name": "host", "required": false, "type": "string" }, { - "description": "the password for the host", + "description": "import instance to the domain specified", "length": 255, - "name": "password", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the template for the virtual machine", + "description": "(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v migration from VMware to KVM.", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "convertinstancehostid", + "related": "", "required": false, "type": "uuid" + }, + { + "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", + "length": 255, + "name": "datacentername", + "required": false, + "type": "string" } ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances", "response": [ { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "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 read in KiB", + "name": "diskkbsread", + "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": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "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", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "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", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "resource type", - "name": "resourcetype", + "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 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": "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": "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" + }, + { + "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": "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" + } + ], + "type": "set" + }, + { + "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": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the domain associated with the tag", + "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 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 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 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 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" + }, + { + "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 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 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 project name of the group", + "name": "project", + "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 domain name of the security group", "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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 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": "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": "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": "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": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "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": "Guest vm Boot Mode", + "name": "bootmode", + "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 name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -155852,8 +156428,8 @@ "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" }, { @@ -155862,13 +156438,18 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "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", "type": "string" }, { @@ -155877,51 +156458,21 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "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 availability zone for the virtual machine", - "name": "zonename", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { @@ -155930,224 +156481,240 @@ "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "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 total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "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 project id of the vm", - "name": "projectid", + "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", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "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": "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": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, - {}, - { - "description": "the state of the virtual machine", - "name": "state", - "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 network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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": "Guest vm Boot Mode", - "name": "bootmode", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "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 of the vm", + "name": "projectid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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 project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "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 (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "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" }, { @@ -156156,69 +156723,74 @@ "type": "list" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, + { + "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 ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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 IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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 vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { "description": "the ip address of the nic", @@ -156226,127 +156798,137 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "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", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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" } ], "type": "set" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "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 control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "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": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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 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 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", + "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 network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { "description": "the id of userdata used for the VM", @@ -156354,514 +156936,76 @@ "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", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, + {}, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "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 memory used by the VM in KiB", - "name": "memorykbs", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, - {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "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", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the VM's primary IP address", + "name": "ipaddress", "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 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": "the ID of the domain associated with the tag", - "name": "domainid", - "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 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 name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "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 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 code for the ICMP message response", - "name": "icmpcode", - "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 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 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 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": "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": "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" - }, - { - "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" - } - ], - "type": "set" - }, - { - "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 name of the security group", - "name": "name", - "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 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 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 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": "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 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 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 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" - } - ], - "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" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "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 project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "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": "the type of the affinity group", - "name": "type", - "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" - } - ], - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" } ], "since": "4.19.0" @@ -156895,17 +157039,17 @@ "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", @@ -156919,18 +157063,18 @@ "name": "listAffinityGroupTypes", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -156948,17 +157092,17 @@ "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" + }, + {} ] }, { @@ -156967,16 +157111,17 @@ "name": "listCapacity", "params": [ { - "description": "List by keyword", + "description": "Sort the results. Available values: Usage", "length": 255, - "name": "keyword", + "name": "sortby", "required": false, + "since": "3.0.0", "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -156990,117 +157135,99 @@ "type": "uuid" }, { - "description": "recalculate capacities and fetch the latest", + "description": "List by keyword", "length": 255, - "name": "fetchlatest", + "name": "keyword", "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": "lists capacity by the Pod ID", + "description": "", "length": 255, - "name": "podid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "lists capacity by the Zone ID", + "description": "recalculate capacities and fetch the latest", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "fetchlatest", "required": false, - "type": "uuid" + "since": "3.0.0", + "type": "boolean" }, { - "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": "lists capacity by the Pod ID", "length": 255, - "name": "type", + "name": "podid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Tag for the resource type", + "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": "tag", + "name": "type", "required": false, - "since": "4.20.0", - "type": "string" + "type": "integer" }, { - "description": "", + "description": "lists capacity by the Zone ID", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, - {}, { "description": "the capacity currently in use", "name": "capacityused", "type": "long" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the Zone ID", "name": "zoneid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -157109,8 +157236,13 @@ "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -157118,10 +157250,22 @@ "name": "capacitytotal", "type": "long" }, + {}, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + {}, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" } ] }, @@ -157130,6 +157274,13 @@ "isasync": false, "name": "updateServiceOffering", "params": [ + { + "description": "the display text of the service offering to be updated", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, { "description": "the ID of the service offering to be updated", "length": 255, @@ -157139,40 +157290,41 @@ "type": "uuid" }, { - "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", + "description": "sort key of the service offering, integer", "length": 255, - "name": "storagetags", + "name": "sortkey", "required": false, - "since": "4.16", - "type": "string" + "type": "integer" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", "length": 255, - "name": "zoneid", + "name": "storagetags", "required": false, - "since": "4.13", + "since": "4.16", "type": "string" }, { - "description": "the display text of the service offering to be updated", + "description": "the name of the service offering to be updated", "length": 255, - "name": "displaytext", + "name": "name", "required": false, "type": "string" }, { - "description": "state of the service offering", + "description": "Whether to cleanup VM and its associated resource upon expunge", "length": 255, - "name": "state", + "name": "purgeresources", "required": false, - "type": "string" + "since": "4.20", + "type": "boolean" }, { - "description": "the name of the service offering to be updated", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "name", + "name": "zoneid", "required": false, + "since": "4.13", "type": "string" }, { @@ -157184,24 +157336,16 @@ "type": "string" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "length": 255, - "name": "purgeresources", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", "required": false, - "since": "4.20", - "type": "boolean" + "type": "string" }, { - "description": "sort key of the service offering, integer", + "description": "state of the service offering", "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", + "name": "state", "required": false, "type": "string" } @@ -157209,174 +157353,33 @@ "related": "", "response": [ { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", - "type": "string" - }, - { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "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", - "type": "boolean" - }, - { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { "description": "true if disk offering uses custom iops, false otherwise", "name": "iscustomizediops", "type": "boolean" }, - { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" - }, - { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" - }, - { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "state of the service offering", - "name": "state", - "type": "string" - }, - { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" - }, - { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "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": "the date this service offering was created", - "name": "created", - "type": "date" - }, - { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" - }, - { - "description": "the id of the service offering", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" - }, - { - "description": "the name of the service offering", - "name": "name", - "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 max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, { "description": "an alternate display text of the service offering.", "name": "displaytext", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" - }, - {}, - { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" - }, - { - "description": "the storage type for this service offering", - "name": "storagetype", - "type": "string" - }, - { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "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 ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" }, { @@ -157385,85 +157388,39 @@ "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": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" - }, - { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "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": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "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 seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { "description": "Whether to cleanup VM and its associated resource upon expunge", "name": "purgeresources", "type": "boolean" }, - { - "description": "is this a system vm offering", - "name": "issystem", - "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": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" - }, - { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" - }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", - "type": "string" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { "description": "the cache mode to use for this disk offering. none, writeback or writethrough", @@ -157471,677 +157428,268 @@ "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" - } - ] - }, - { - "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": "The ID of the virtual machine", - "length": 255, + "description": "the id of the service offering", "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": true, - "type": "uuid" - } - ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "response": [ - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", "type": "string" }, { - "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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the storage type for this service offering", + "name": "storagetype", "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "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 netmask of the nic", - "name": "netmask", - "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 gateway of the nic", - "name": "gateway", - "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": "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 name of the corresponding network", - "name": "networkname", - "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 ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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": "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 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 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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the memory in MB", + "name": "memory", "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "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 domain ID of the affinity group", - "name": "domainid", - "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 project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "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 domain name of the affinity group", - "name": "domain", - "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 type of the affinity group", - "name": "type", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the service offering", + "name": "name", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "is this a system vm offering", + "name": "issystem", "type": "boolean" }, { - "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 ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "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", + "description": "name of the disk offering", "name": "diskofferingname", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "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": "Vm details in key/value pairs.", - "name": "details", + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", "type": "map" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "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", + "type": "boolean" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, + {}, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "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", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the 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": "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 total number of network traffic bytes sent", - "name": "sentbytes", + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "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 resource tags associated", - "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": "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" - }, - { - "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "state of the service offering", + "name": "state", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" - }, + } + ] + }, + { + "description": "Stops a virtual machine.", + "isasync": true, + "name": "stopVirtualMachine", + "params": [ { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "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,listVnfAppliances", + "required": true, + "type": "uuid" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances", + "response": [ + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { "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 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 ID of the security group", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the 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", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -158154,13 +157702,13 @@ "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 name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -158169,33 +157717,33 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -158212,8 +157760,8 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -158221,6 +157769,11 @@ "name": "startport", "type": "integer" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the ending IP of the security group rule ", "name": "endport", @@ -158232,78 +157785,103 @@ "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "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 ID of the security group", + "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", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "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", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "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": "resource type", + "name": "resourcetype", "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "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" }, { @@ -158312,19 +157890,19 @@ "type": "integer" }, { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", + "description": "the description of the security group", + "name": "description", "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 protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "security group name", "name": "securitygroupname", @@ -158336,13 +157914,18 @@ "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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" }, { @@ -158351,32 +157934,32 @@ "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": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "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", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -158385,52 +157968,42 @@ "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", + "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" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "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" @@ -158439,19 +158012,160 @@ "description": "the account owning the security group", "name": "account", "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" } ], "type": "set" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "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 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 backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "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", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "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 amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { "description": "List of read-only Vm details as comma separated string.", @@ -158464,24 +158178,24 @@ "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the 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 project name of the vm", - "name": "project", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, {}, { @@ -158490,76 +158204,192 @@ "type": "integer" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "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 availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "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 name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", "type": "date" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "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 description of the affinity group", + "name": "description", + "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 project name of the affinity group", + "name": "project", + "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 type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" + }, { "description": "an optional field whether to the display the vm to the end user or not.", "name": "displayvm", "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { "description": "the memory used by the VM in KiB", @@ -158567,29 +158397,268 @@ "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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": "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 virtual machine", + "name": "id", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "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 type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "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 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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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 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 netmask of the nic", + "name": "netmask", + "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 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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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 nic", + "name": "id", + "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": "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" + } + ], + "type": "set" + }, + { + "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 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 id the tag belongs to", + "name": "projectid", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { "description": "the account associated with the virtual machine", @@ -158597,8 +158666,83 @@ "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "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 network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "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", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "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 group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "User VM type", + "name": "vmtype", "type": "string" } ] @@ -158608,20 +158752,6 @@ "isasync": true, "name": "createNetworkACLList", "params": [ - { - "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" - }, { "description": "an optional field, whether to the display the list to the end user or not", "length": 255, @@ -158630,6 +158760,13 @@ "since": "4.4", "type": "boolean" }, + { + "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, @@ -158637,39 +158774,42 @@ "related": "createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" + }, + { + "description": "Name of the network ACL list", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "", "response": [ - { - "description": "the Name of the ACL", - "name": "name", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Description of the ACL", - "name": "description", + "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": "Name of the VPC this ACL is associated with", + "name": "vpcname", + "type": "string" }, { "description": "Id of the VPC this ACL is associated with", "name": "vpcid", "type": "string" }, + {}, + {}, { - "description": "the ID of the ACL", - "name": "id", + "description": "Description of the ACL", + "name": "description", "type": "string" }, { @@ -158678,11 +158818,15 @@ "type": "boolean" }, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "the Name of the ACL", + "name": "name", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] } ], diff --git a/test/testdata/VirtualMachineService.json b/test/testdata/VirtualMachineService.json index d0f36a34..45b1da38 100644 --- a/test/testdata/VirtualMachineService.json +++ b/test/testdata/VirtualMachineService.json @@ -505,5 +505,67 @@ "completed": "2021-10-13T04:54:56+0000", "jobid": "f9a9af61-47ea-4fb7-acc9-93ea50f12042" } + }, + "listVirtualMachinesUsageHistory": { + "listvirtualmachinesusagehistoryresponse": { + "count": 1, + "virtualmachine": [ + { + "id": "4f6d7879-8e9d-40cb-9390-28924a31df78", + "name": "i-5-39-VM", + "displayname": "ubuntu-01", + "stats": [ + { + "timestamp": "2024-12-31T17:54:37+0600", + "cpuused": "55.56%", + "diskioread": 0, + "diskiowrite": 0, + "diskiopstotal": 0, + "diskkbsread": 0, + "diskkbswrite": 0, + "memoryintfreekbs": 182168, + "memorykbs": 1048576, + "memorytargetkbs": 1048576, + "networkkbsread": 0, + "networkkbswrite": 0, + "networkread": "0.00 MiB", + "networkwrite": "0.00 MiB" + }, + { + "timestamp": "2024-12-31T17:54:37+0600", + "cpuused": "0.2%", + "diskioread": 0, + "diskiowrite": 0, + "diskiopstotal": 0, + "diskkbsread": 0, + "diskkbswrite": 0, + "memoryintfreekbs": 182168, + "memorykbs": 1048576, + "memorytargetkbs": 1048576, + "networkkbsread": 0, + "networkkbswrite": 0, + "networkread": "0.00 MiB", + "networkwrite": "0.00 MiB" + }, + { + "timestamp": "2024-12-31T17:54:37+0600", + "cpuused": "11.43%", + "diskioread": 0, + "diskiowrite": 0, + "diskiopstotal": 0, + "diskkbsread": 0, + "diskkbswrite": 0, + "memoryintfreekbs": 182168, + "memorykbs": 1048576, + "memorytargetkbs": 1048576, + "networkkbsread": 0, + "networkkbswrite": 0, + "networkread": "0.00 MiB", + "networkwrite": "0.00 MiB" + } + ] + } + ] + } } } \ No newline at end of file From 818910e6d690f55e8d20282a7d9c8cd07f61beff Mon Sep 17 00:00:00 2001 From: Pearl Dsilva Date: Fri, 3 Jan 2025 08:30:03 -0500 Subject: [PATCH 2/2] linting issue --- test/testdata/VirtualMachineService.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/testdata/VirtualMachineService.json b/test/testdata/VirtualMachineService.json index 45b1da38..0347d0b7 100644 --- a/test/testdata/VirtualMachineService.json +++ b/test/testdata/VirtualMachineService.json @@ -568,4 +568,4 @@ ] } } -} \ No newline at end of file +}