You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ro...@apache.org on 2021/07/27 06:26:15 UTC
[cloudstack-go] 01/03: listApis: update as per 4.15.1.0 version
This is an automated email from the ASF dual-hosted git repository.
rohit pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack-go.git
commit fb793b49c1f8f98df1ade64201dbb30c7065ee0b
Author: Rohit Yadav <ro...@shapeblue.com>
AuthorDate: Tue Jul 27 11:53:50 2021 +0530
listApis: update as per 4.15.1.0 version
Signed-off-by: Rohit Yadav <ro...@shapeblue.com>
---
generate/listApis.json | 222421 ++++++++++++++++++++++++----------------------
1 file changed, 117662 insertions(+), 104759 deletions(-)
diff --git a/generate/listApis.json b/generate/listApis.json
index c485670..e53f1b8 100644
--- a/generate/listApis.json
+++ b/generate/listApis.json
@@ -1,106215 +1,119118 @@
{
- "api": [
+ "api": [
+ {
+ "description": "Creates VPC offering",
+ "isasync": true,
+ "name": "createVPCOffering",
+ "params": [
+ {
+ "description": "the name of the vpc offering",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network",
+ "length": 255,
+ "name": "serviceproviderlist",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "the ID of the containing zone(s), null for public offerings",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "since": "4.13",
+ "type": "list"
+ },
+ {
+ "description": "the ID of the containing domain(s), null for public offerings",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the display text of the vpc offering",
+ "length": 255,
+ "name": "displaytext",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "services supported by the vpc offering",
+ "length": 255,
+ "name": "supportedservices",
+ "required": true,
+ "type": "list"
+ },
+ {
+ "description": "desired service capabilities as part of vpc offering",
+ "length": 255,
+ "name": "servicecapabilitylist",
+ "required": false,
+ "since": "4.4",
+ "type": "map"
+ },
+ {
+ "description": "the ID of the service offering for the VPC router appliance",
+ "length": 255,
+ "name": "serviceofferingid",
+ "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
+ "required": false,
+ "type": "uuid"
+ }
+ ],
+ "related": "updateVPCOffering,listVPCOfferings",
+ "response": [
{
- "name": "createVPCOffering",
- "description": "Creates VPC offering",
- "isasync": true,
- "related": "updateVPCOffering,listVPCOfferings",
- "params": [
- {
- "name": "servicecapabilitylist",
- "description": "desired service capabilities as part of vpc offering",
- "type": "map",
- "length": 255,
- "required": false,
- "since": "4.4"
- },
- {
- "name": "displaytext",
- "description": "the display text of the vpc offering",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "serviceproviderlist",
- "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network",
- "type": "map",
- "length": 255,
- "required": false
- },
- {
- "name": "supportedservices",
- "description": "services supported by the vpc offering",
- "type": "list",
- "length": 255,
- "required": true
- },
- {
- "name": "serviceofferingid",
- "description": "the ID of the service offering for the VPC router appliance",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createServiceOffering,listServiceOfferings,updateServiceOffering"
- },
- {
- "name": "name",
- "description": "the name of the vpc offering",
- "type": "string",
- "length": 255,
- "required": true
- }
- ],
- "response": [
- {
- "name": "created",
- "description": "the date this vpc offering was created",
- "type": "date"
- },
- {
-
- },
- {
- "name": "id",
- "description": "the id of the vpc offering",
- "type": "string"
- },
- {
- "name": "service",
- "description": "the list of supported services",
- "type": "list",
- "response": [
- {
- "name": "provider",
- "description": "the service provider name",
- "type": "list",
- "response": [
- {
- "name": "name",
- "description": "the provider name",
- "type": "string"
- },
- {
- "name": "servicelist",
- "description": "services for this provider",
- "type": "list"
- },
- {
- "name": "physicalnetworkid",
- "description": "the physical network this belongs to",
- "type": "string"
- },
- {
- "name": "id",
- "description": "uuid of the network provider",
- "type": "string"
- },
- {
- "name": "canenableindividualservice",
- "description": "true if individual services can be enabled/disabled",
- "type": "boolean"
- },
- {
- "name": "destinationphysicalnetworkid",
- "description": "the destination physical network",
- "type": "string"
- },
- {
- "name": "state",
- "description": "state of the network provider",
- "type": "string"
- }
- ]
- },
- {
- "name": "capability",
- "description": "the list of capabilities",
- "type": "list",
- "response": [
- {
- "name": "canchooseservicecapability",
- "description": "can this service capability value can be choosable while creatine network offerings",
- "type": "boolean"
- },
- {
- "name": "value",
- "description": "the capability value",
- "type": "string"
- },
- {
- "name": "name",
- "description": "the capability name",
- "type": "string"
- }
- ]
- },
- {
- "name": "name",
- "description": "the service name",
- "type": "string"
- }
- ]
- },
- {
- "name": "distributedvpcrouter",
- "description": " indicates if the vpc offering supports distributed router for one-hop forwarding",
- "type": "boolean"
- },
- {
- "name": "supportsregionLevelvpc",
- "description": " indicated if the offering can support region level vpc",
- "type": "boolean"
- },
- {
- "name": "state",
- "description": "state of the vpc offering. Can be Disabled/Enabled",
- "type": "string"
- },
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "isdefault",
- "description": "true if vpc offering is default, false otherwise",
- "type": "boolean"
- },
- {
- "name": "name",
- "description": "the name of the vpc offering",
- "type": "string"
- },
- {
- "name": "displaytext",
- "description": "an alternate display text of the vpc offering.",
- "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"
},
{
- "name": "createPod",
- "description": "Creates a new Pod.",
- "isasync": false,
- "related": "listPods,createManagementNetworkIpRange,updatePod",
- "params": [
- {
- "name": "netmask",
- "description": "the netmask for the Pod",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "allocationstate",
- "description": "Allocation state of this Pod for allocation of new resources",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "startip",
- "description": "the starting IP address for the Pod",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "name",
- "description": "the name of the Pod",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "endip",
- "description": "the ending IP address for the Pod",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "gateway",
- "description": "the gateway for the Pod",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "zoneid",
- "description": "the Zone ID in which the Pod will be created",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "createZone,updateZone,listZones,listZones"
- }
- ],
- "response": [
- {
- "name": "forsystemvms",
- "description": "indicates if range is dedicated for CPVM and SSVM",
- "type": "list"
- },
- {
- "name": "zonename",
- "description": "the Zone name of the Pod",
- "type": "string"
- },
- {
-
- },
- {
- "name": "gateway",
- "description": "the gateway of the Pod",
- "type": "string"
- },
- {
- "name": "name",
- "description": "the name of the Pod",
- "type": "string"
- },
- {
- "name": "vlanid",
- "description": "indicates Vlan ID for the range",
- "type": "list"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "capacity",
- "description": "the capacity of the Pod",
- "type": "list",
- "response": [
- {
- "name": "podid",
- "description": "the Pod ID",
- "type": "string"
- },
- {
- "name": "capacitytotal",
- "description": "the total capacity available",
- "type": "long"
- },
- {
- "name": "name",
- "description": "the capacity name",
- "type": "string"
- },
- {
- "name": "zonename",
- "description": "the Zone name",
- "type": "string"
- },
- {
- "name": "clusterid",
- "description": "the Cluster ID",
- "type": "string"
- },
- {
- "name": "clustername",
- "description": "the Cluster name",
- "type": "string"
- },
- {
- "name": "percentused",
- "description": "the percentage of capacity currently in use",
- "type": "string"
- },
- {
- "name": "type",
- "description": "the capacity type",
- "type": "short"
- },
- {
- "name": "podname",
- "description": "the Pod name",
- "type": "string"
- },
- {
- "name": "zoneid",
- "description": "the Zone ID",
- "type": "string"
- },
- {
- "name": "capacityallocated",
- "description": "the capacity currently in allocated",
- "type": "long"
- },
- {
- "name": "capacityused",
- "description": "the capacity currently in use",
- "type": "long"
- }
- ]
- },
- {
- "name": "zoneid",
- "description": "the Zone ID of the Pod",
- "type": "string"
- },
- {
-
- },
- {
- "name": "id",
- "description": "the ID of the Pod",
- "type": "string"
- },
- {
- "name": "startip",
- "description": "the starting IP for the Pod",
- "type": "list"
- },
- {
- "name": "netmask",
- "description": "the netmask of the Pod",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "allocationstate",
- "description": "the allocation state of the Pod",
- "type": "string"
- },
- {
- "name": "endip",
- "description": "the ending IP for the Pod",
- "type": "list"
- }
- ]
+ "description": "true if vpc offering is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
},
{
- "name": "ldapCreateAccount",
- "description": "Creates an account from an LDAP user",
- "since": "4.2.0",
- "isasync": false,
- "related": "enableAccount,createAccount,markDefaultZoneForAccount,lockAccount,updateAccount,listAccounts,disableAccount,listAccounts",
- "params": [
- {
- "name": "roleid",
- "description": "Creates the account under the specified role.",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "updateRole,createRole,listRoles"
- },
- {
- "name": "domainid",
- "description": "Creates the user under the specified domain.",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listDomains,listDomains,listDomainChildren,updateDomain,createDomain"
- },
- {
- "name": "userid",
- "description": "User UUID, required for adding account from external provisioning system",
- "type": "string",
- "length": 255,
- "required": false
- },
+ "description": "the id of the vpc offering",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the vpc offering",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": " indicated if the offering can support region level vpc",
+ "name": "supportsregionLevelvpc",
+ "type": "boolean"
+ },
+ {
+ "description": "the list of supported services",
+ "name": "service",
+ "response": [
+ {
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the service provider name",
+ "name": "provider",
+ "response": [
{
- "name": "timezone",
- "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
- "type": "string",
- "length": 255,
- "required": false
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
},
{
- "name": "networkdomain",
- "description": "Network domain for the account's networks",
- "type": "string",
- "length": 255,
- "required": false
+ "description": "the provider name",
+ "name": "name",
+ "type": "string"
},
{
- "name": "username",
- "description": "Unique username.",
- "type": "string",
- "length": 255,
- "required": true
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
},
{
- "name": "accounttype",
- "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
- "type": "short",
- "length": 255,
- "required": false
+ "description": "state of the network provider",
+ "name": "state",
+ "type": "string"
},
{
- "name": "accountdetails",
- "description": "details for account used to store specific parameters",
- "type": "map",
- "length": 255,
- "required": false
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
+ "type": "string"
},
{
- "name": "account",
- "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.",
- "type": "string",
- "length": 255,
- "required": false
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
},
{
- "name": "accountid",
- "description": "Account UUID, required for adding account from external provisioning system",
- "type": "string",
- "length": 255,
- "required": false
+ "description": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
}
- ],
- "response": [
- {
- "name": "memorytotal",
- "description": "the total memory (in MB) owned by account",
- "type": "long"
- },
- {
- "name": "cpuavailable",
- "description": "the total number of cpu cores available to be created for this account",
- "type": "string"
- },
- {
- "name": "volumeavailable",
- "description": "the total volume available for this account",
- "type": "string"
- },
- {
- "name": "cpulimit",
- "description": "the total number of cpu cores the account can own",
- "type": "string"
- },
- {
- "name": "templateavailable",
- "description": "the total number of templates available to be created by this account",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the id of the account",
- "type": "string"
- },
- {
- "name": "projecttotal",
- "description": "the total number of projects being administrated by this account",
- "type": "long"
- },
- {
- "name": "name",
- "description": "the name of the account",
- "type": "string"
- },
- {
- "name": "iptotal",
- "description": "the total number of public ip addresses allocated for this account",
- "type": "long"
- },
- {
- "name": "roletype",
- "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
- "type": "string"
- },
- {
- "name": "networkavailable",
- "description": "the total number of networks available to be created for this account",
- "type": "string"
- },
- {
- "name": "rolename",
- "description": "the name of the role",
- "type": "string"
- },
- {
- "name": "accounttype",
- "description": "account type (admin, domain-admin, user)",
- "type": "short"
- },
- {
- "name": "memorylimit",
- "description": "the total memory (in MB) the account can own",
- "type": "string"
- },
- {
- "name": "volumetotal",
- "description": "the total volume being used by this account",
- "type": "long"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "vmtotal",
- "description": "the total number of virtual machines deployed by this account",
- "type": "long"
- },
- {
- "name": "iscleanuprequired",
- "description": "true if the account requires cleanup",
- "type": "boolean"
- },
- {
- "name": "networkdomain",
- "description": "the network domain",
- "type": "string"
- },
- {
- "name": "snapshottotal",
- "description": "the total number of snapshots stored by this account",
- "type": "long"
- },
- {
- "name": "templatelimit",
- "description": "the total number of templates which can be created by this account",
- "type": "string"
- },
- {
- "name": "defaultzoneid",
- "description": "the default zone of the account",
- "type": "string"
- },
- {
- "name": "vmavailable",
- "description": "the total number of virtual machines available for this account to acquire",
- "type": "string"
- },
- {
- "name": "vpcavailable",
- "description": "the total number of vpcs available to be created for this account",
- "type": "string"
- },
- {
- "name": "iplimit",
- "description": "the total number of public ip addresses this account can acquire",
- "type": "string"
- },
- {
- "name": "vmrunning",
- "description": "the total number of virtual machines running for this account",
- "type": "integer"
- },
- {
- "name": "snapshotlimit",
- "description": "the total number of snapshots which can be stored by this account",
- "type": "string"
- },
- {
- "name": "user",
- "description": "the list of users associated with account",
- "type": "list",
- "response": [
- {
- "name": "accounttype",
- "description": "the account type of the user",
- "type": "short"
- },
- {
- "name": "domainid",
- "description": "the domain ID of the user",
- "type": "string"
- },
- {
- "name": "created",
- "description": "the date and time the user account was created",
- "type": "date"
- },
- {
- "name": "usersource",
- "description": "the source type of the user in lowercase, such as native, ldap, saml2",
- "type": "string"
- },
- {
- "name": "accountid",
- "description": "the account ID of the user",
- "type": "string"
- },
- {
- "name": "state",
- "description": "the user state",
- "type": "string"
- },
- {
- "name": "rolename",
- "description": "the name of the role",
- "type": "string"
- },
- {
- "name": "roleid",
- "description": "the ID of the role",
- "type": "string"
- },
- {
- "name": "timezone",
- "description": "the timezone user was created in",
- "type": "string"
- },
- {
- "name": "email",
- "description": "the user email address",
- "type": "string"
- },
- {
- "name": "apikey",
- "description": "the api key of the user",
- "type": "string"
- },
- {
- "name": "isdefault",
- "description": "true if user is default, false otherwise",
- "type": "boolean"
- },
- {
- "name": "firstname",
- "description": "the user firstname",
- "type": "string"
- },
- {
- "name": "lastname",
- "description": "the user lastname",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain name of the user",
- "type": "string"
- },
- {
- "name": "iscallerchilddomain",
- "description": "the boolean value representing if the updating target is in caller's child domain",
- "type": "boolean"
- },
- {
- "name": "username",
- "description": "the user name",
- "type": "string"
- },
- {
- "name": "roletype",
- "description": "the type of the role",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the user ID",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account name of the user",
- "type": "string"
- },
- {
- "name": "secretkey",
- "description": "the secret key of the user",
- "type": "string"
- }
- ]
- },
- {
- "name": "vpclimit",
- "description": "the total number of vpcs the account can own",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "volumelimit",
- "description": "the total volume which can be used by this account",
- "type": "string"
- },
- {
- "name": "networklimit",
- "description": "the total number of networks the account can own",
- "type": "string"
- },
- {
-
- },
- {
- "name": "vmlimit",
- "description": "the total number of virtual machines that can be deployed by this account",
- "type": "string"
- },
- {
- "name": "secondarystoragetotal",
- "description": "the total secondary storage space (in GiB) owned by account",
- "type": "float"
- },
- {
- "name": "networktotal",
- "description": "the total number of networks owned by account",
- "type": "long"
- },
- {
- "name": "sentbytes",
- "description": "the total number of network traffic bytes sent",
- "type": "long"
- },
- {
- "name": "primarystorageavailable",
- "description": "the total primary storage space (in GiB) available to be used for this account",
- "type": "string"
- },
- {
- "name": "vpctotal",
- "description": "the total number of vpcs owned by account",
- "type": "long"
- },
- {
- "name": "projectlimit",
- "description": "the total number of projects the account can own",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "id of the Domain the account belongs too",
- "type": "string"
- },
- {
- "name": "receivedbytes",
- "description": "the total number of network traffic bytes received",
- "type": "long"
- },
- {
- "name": "vmstopped",
- "description": "the total number of virtual machines stopped for this account",
- "type": "integer"
- },
- {
- "name": "cputotal",
- "description": "the total number of cpu cores owned by account",
- "type": "long"
- },
- {
- "name": "secondarystorageavailable",
- "description": "the total secondary storage space (in GiB) available to be used for this account",
- "type": "string"
- },
- {
-
- },
- {
- "name": "snapshotavailable",
- "description": "the total number of snapshots available for this account",
- "type": "string"
- },
- {
- "name": "primarystoragelimit",
- "description": "the total primary storage space (in GiB) the account can own",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "name of the Domain the account belongs too",
- "type": "string"
- },
- {
- "name": "ipavailable",
- "description": "the total number of public ip addresses available for this account to acquire",
- "type": "string"
- },
- {
- "name": "projectavailable",
- "description": "the total number of projects available for administration by this account",
- "type": "string"
- },
- {
- "name": "isdefault",
- "description": "true if account is default, false otherwise",
- "type": "boolean"
- },
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the list of capabilities",
+ "name": "capability",
+ "response": [
{
- "name": "groups",
- "description": "the list of acl groups that account belongs to",
- "type": "list"
+ "description": "the capability name",
+ "name": "name",
+ "type": "string"
},
{
- "name": "primarystoragetotal",
- "description": "the total primary storage space (in GiB) owned by account",
- "type": "long"
+ "description": "can this service capability value can be choosable while creatine network offerings",
+ "name": "canchooseservicecapability",
+ "type": "boolean"
},
{
- "name": "memoryavailable",
- "description": "the total memory (in MB) available to be created for this account",
- "type": "string"
- },
- {
- "name": "state",
- "description": "the state of the account",
- "type": "string"
- },
- {
- "name": "roleid",
- "description": "the ID of the role",
- "type": "string"
- },
- {
- "name": "secondarystoragelimit",
- "description": "the total secondary storage space (in GiB) the account can own",
- "type": "string"
- },
- {
- "name": "templatetotal",
- "description": "the total number of templates which have been created by this account",
- "type": "long"
- },
- {
- "name": "accountdetails",
- "description": "details for the account",
- "type": "map"
+ "description": "the capability value",
+ "name": "value",
+ "type": "string"
}
- ]
+ ],
+ "type": "list"
+ }
+ ],
+ "type": "list"
},
{
- "name": "removeRawUsageRecords",
- "description": "Safely removes raw records from cloud_usage table",
- "since": "4.6.0",
- "isasync": false,
- "params": [
- {
- "name": "interval",
- "description": "Specify the number of days (greater than zero) to remove records that are older than those number of days from today. For example, specifying 10 would result in removing all the records created before 10 days from today",
- "type": "integer",
- "length": 255,
- "required": true
- }
- ],
- "response": [
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- },
- {
-
- },
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- }
- ]
+ "description": "the date this vpc offering was created",
+ "name": "created",
+ "type": "date"
},
{
- "name": "copyIso",
- "description": "Copies an iso from one zone to another.",
- "isasync": true,
- "related": "updateTemplate,listIsos,createTemplate,listTemplates,registerTemplate,registerIso,registerTemplate,prepareTemplate,copyTemplate,createTemplate,updateIso,listIsos,copyTemplate,copyIso,registerIso,listTemplates",
- "params": [
- {
- "name": "destzoneid",
- "description": "ID of the zone the template is being copied to.",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createZone,updateZone,listZones,listZones"
- },
- {
- "name": "sourcezoneid",
- "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.",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createZone,updateZone,listZones,listZones"
- },
- {
- "name": "destzoneids",
- "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.",
- "type": "list",
- "length": 255,
- "required": false,
- "related": "createZone,updateZone,listZones,listZones"
- },
- {
- "name": "id",
- "description": "Template ID.",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "updateTemplate,listIsos,createTemplate,listTemplates,registerTemplate,registerIso,registerTemplate,prepareTemplate,copyTemplate,createTemplate,updateIso,copyIso,listIsos,copyTemplate,copyIso,registerIso,listTemplates"
- }
- ],
- "response": [
- {
- "name": "hypervisor",
- "description": "the hypervisor on which the template runs",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name of the template",
- "type": "string"
- },
- {
- "name": "crossZones",
- "description": "true if the template is managed across all Zones, false otherwise",
- "type": "boolean"
- },
- {
- "name": "ostypeid",
- "description": "the ID of the OS type for this template.",
- "type": "string"
- },
- {
- "name": "isextractable",
- "description": "true if the template is extractable, false otherwise",
- "type": "boolean"
- },
- {
- "name": "zoneid",
- "description": "the ID of the zone for this template",
- "type": "string"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated",
- "type": "set",
- "response": [
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- },
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- }
- ]
- },
- {
- "name": "account",
- "description": "the account name to which the template belongs",
- "type": "string"
- },
- {
- "name": "hostname",
- "description": "the name of the secondary storage host for the template",
- "type": "string"
- },
- {
- "name": "accountid",
- "description": "the account id to which the template belongs",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain to which the template belongs",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "sourcetemplateid",
- "description": "the template ID of the parent template if present",
- "type": "string"
- },
- {
- "name": "size",
- "description": "the size of the template",
- "type": "long"
- },
- {
- "name": "checksum",
- "description": "checksum of the template",
- "type": "string"
- },
- {
- "name": "templatetype",
- "description": "the type of the template",
- "type": "string"
- },
- {
- "name": "requireshvm",
- "description": "true if template requires HVM enabled, false otherwise",
- "type": "boolean"
- },
- {
- "name": "parenttemplateid",
- "description": "if Datadisk template, then id of the root disk template this template belongs to",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the template ID",
- "type": "string"
- },
- {
- "name": "format",
- "description": "the format of the template.",
- "type": "imageformat"
- },
- {
- "name": "directdownload",
- "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
- "type": "boolean"
- },
- {
- "name": "zonename",
- "description": "the name of the zone for this template",
- "type": "string"
- },
- {
- "name": "name",
- "description": "the template name",
- "type": "string"
- },
- {
- "name": "created",
- "description": "the date this template was created",
- "type": "date"
- },
- {
-
- },
- {
- "name": "isdynamicallyscalable",
- "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
- "type": "boolean"
- },
- {
- "name": "hostid",
- "description": "the ID of the secondary storage host for the template",
- "type": "string"
- },
- {
- "name": "childtemplates",
- "description": "if root disk template, then ids of the datas disk templates this template owns",
- "type": "set"
- },
- {
- "name": "removed",
- "description": "the date this template was removed",
- "type": "date"
- },
- {
- "name": "isready",
- "description": "true if the template is ready to be deployed from, false otherwise.",
- "type": "boolean"
- },
- {
- "name": "status",
- "description": "the status of the template",
- "type": "string"
- },
- {
- "name": "passwordenabled",
- "description": "true if the reset password feature is enabled, false otherwise",
- "type": "boolean"
- },
- {
- "name": "domain",
- "description": "the name of the domain to which the template belongs",
- "type": "string"
- },
- {
- "name": "details",
- "description": "additional key/value details tied with template",
- "type": "map"
- },
- {
- "name": "isfeatured",
- "description": "true if this template is a featured template, false otherwise",
- "type": "boolean"
- },
- {
- "name": "ispublic",
- "description": "true if this template is a public template, false otherwise",
- "type": "boolean"
- },
- {
- "name": "bootable",
- "description": "true if the ISO is bootable, false otherwise",
- "type": "boolean"
- },
- {
- "name": "displaytext",
- "description": "the template display text",
- "type": "string"
- },
- {
- "name": "sshkeyenabled",
- "description": "true if template is sshkey enabled, false otherwise",
- "type": "boolean"
- },
- {
- "name": "physicalsize",
- "description": "the physical size of the template",
- "type": "long"
- },
- {
- "name": "templatetag",
- "description": "the tag of this template",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id of the template",
- "type": "string"
- },
- {
- "name": "ostypename",
- "description": "the name of the OS type for this template.",
- "type": "string"
- },
- {
-
- },
- {
- "name": "bits",
- "description": "the processor bit size",
- "type": "int"
- }
- ]
+ "description": "an alternate display text of the vpc offering.",
+ "name": "displaytext",
+ "type": "string"
},
{
- "name": "deleteAutoScaleVmProfile",
- "description": "Deletes a autoscale vm profile.",
- "isasync": true,
- "params": [
- {
- "name": "id",
- "description": "the ID of the autoscale profile",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "updateAutoScaleVmProfile,listAutoScaleVmProfiles,createAutoScaleVmProfile"
- }
- ],
- "response": [
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- },
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- },
- {
-
- }
- ]
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
+ {},
{
- "name": "provisionCertificate",
- "description": "Issues and propagates client certificate on a connected host/agent using configured CA plugin",
- "since": "4.11.0",
- "isasync": true,
- "params": [
- {
- "name": "hostid",
- "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "prepareHostForMaintenance,cancelHostMaintenance,addHost,reconnectHost,listHosts,addBaremetalHost,updateHost"
- },
- {
- "name": "provider",
- "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "reconnect",
- "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used",
- "type": "boolean",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
-
- },
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- }
- ]
+ "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domainid",
+ "type": "string"
},
+ {},
{
- "name": "listVirtualMachinesMetrics",
- "description": "Lists VM metrics",
- "since": "4.9.3",
- "isasync": false,
- "related": "",
- "params": [
- {
- "name": "isoid",
- "description": "list vms by iso",
- "type": "uuid",
- "length": 255,
- "required": false
- },
- {
- "name": "groupid",
- "description": "the group ID",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup"
- },
- {
- "name": "id",
- "description": "the ID of the virtual machine",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "destroyVirtualMachine,migrateVirtualMachineWithVolume,attachIso,startVirtualMachine,removeNicFromVirtualMachine,updateVirtualMachine,updateVmNicIp,detachIso,rebootVirtualMachine,updateVMAffinityGroup,stopVirtualMachine,detachIso,removeNicFromVirtualMachine,listVirtualMachines,listVirtualMachines,destroyVirtualMachine,attachIso,resetSSHKeyForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,updateDefaultNicForVirtualMachine,assignVirtualMachine,change [...]
- },
- {
- "name": "affinitygroupid",
- "description": "list vms by affinity group",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createAffinityGroup,listAffinityGroups"
- },
- {
- "name": "hypervisor",
- "description": "the target hypervisor for the template",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "projectid",
- "description": "list objects by project",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listProjectAccounts,listProjects,activateProject,createProject,updateProject,suspendProject"
- },
- {
- "name": "storageid",
- "description": "the storage ID where vm's volumes belong to",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,cancelStorageMaintenance,createStoragePool"
- },
- {
- "name": "vpcid",
- "description": "list vms by vpc",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "migrateVPC,listVPCs,updateVPC,listVPCs,createVPC,restartVPC,createVPC,updateVPC"
- },
- {
- "name": "displayvm",
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
- "type": "boolean",
- "length": 255,
- "required": false,
- "since": "4.4"
- },
- {
- "name": "keypair",
- "description": "list vms by ssh keypair name",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "pagesize",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "storageid",
- "description": "the storage ID where vm's volumes belong to",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,cancelStorageMaintenance,createStoragePool"
- },
- {
- "name": "hostid",
- "description": "the host ID",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "prepareHostForMaintenance,cancelHostMaintenance,addHost,reconnectHost,listHosts,addBaremetalHost,updateHost"
- },
- {
- "name": "userid",
- "description": "the user ID that created the VM and is under the account that owns the VM",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "updateUser,lockUser,getUser,enableUser,listUsers,createUser,disableUser"
- },
- {
- "name": "state",
- "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "networkid",
- "description": "list by network id",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listPaloAltoFirewallNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listBrocadeVcsDeviceNetworks,listNetworks,updateNetwork,listNetworks,updateNetwork,createNetwork,createNetwork"
- },
- {
- "name": "page",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "tags",
- "description": "List resources by tags (key/value pairs)",
- "type": "map",
- "length": 255,
- "required": false
- },
- {
- "name": "hostid",
- "description": "the host ID",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "prepareHostForMaintenance,cancelHostMaintenance,addHost,reconnectHost,listHosts,addBaremetalHost,updateHost"
- },
- {
- "name": "zoneid",
- "description": "the availability zone ID",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createZone,updateZone,listZones,listZones"
- },
- {
- "name": "isrecursive",
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "podid",
- "description": "the pod ID",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listPods,createManagementNetworkIpRange,updatePod"
- },
- {
- "name": "keyword",
- "description": "List by keyword",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "ids",
- "description": "the IDs of the virtual machines, mutually exclusive with id",
- "type": "list",
- "length": 255,
- "required": false,
- "since": "4.4",
- "related": "destroyVirtualMachine,migrateVirtualMachineWithVolume,attachIso,startVirtualMachine,removeNicFromVirtualMachine,updateVirtualMachine,updateVmNicIp,detachIso,rebootVirtualMachine,updateVMAffinityGroup,stopVirtualMachine,detachIso,removeNicFromVirtualMachine,listVirtualMachines,listVirtualMachines,destroyVirtualMachine,attachIso,resetSSHKeyForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,updateDefaultNicForVirtualMachine,assignVirtualMachine,change [...]
- },
- {
- "name": "name",
- "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "podid",
- "description": "the pod ID",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listPods,createManagementNetworkIpRange,updatePod"
- },
- {
- "name": "templateid",
- "description": "list vms by template",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "updateTemplate,listIsos,createTemplate,listTemplates,registerTemplate,registerIso,registerTemplate,prepareTemplate,copyTemplate,createTemplate,updateIso,listIsos,copyTemplate,copyIso,registerIso,listTemplates"
- },
- {
- "name": "forvirtualnetwork",
- "description": "list by network type; true if need to list vms using Virtual Network, false otherwise",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "details",
- "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all",
- "type": "list",
- "length": 255,
- "required": false
- },
- {
- "name": "account",
- "description": "list resources by account. Must be used with the domainId parameter.",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "serviceofferingid",
- "description": "list by the service offering",
- "type": "uuid",
- "length": 255,
- "required": false,
- "since": "4.4",
- "related": "createServiceOffering,listServiceOfferings,updateServiceOffering"
- },
- {
- "name": "listall",
- "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",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "domainid",
- "description": "list only resources belonging to the domain specified",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listDomains,listDomains,listDomainChildren,updateDomain,createDomain"
- }
- ],
- "response": [
- {
- "name": "templatename",
- "description": "the name of the template for the virtual machine",
- "type": "string"
- },
- {
- "name": "diskofferingname",
- "description": "the name of the disk offering of the virtual machine",
- "type": "string"
- },
- {
- "name": "diskiopstotal",
- "description": "the total disk iops",
- "type": "long"
- },
- {
- "name": "haenable",
- "description": "true if high-availability is enabled, false otherwise",
- "type": "boolean"
- },
- {
- "name": "templatedisplaytext",
- "description": " an alternate display text of the template for the virtual machine",
- "type": "string"
- },
- {
- "name": "isodisplaytext",
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "type": "string"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated",
- "type": "set",
- "response": [
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- },
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- }
- ]
- },
- {
- "name": "diskiowrite",
- "description": "the write (io) of disk on the vm",
- "type": "long"
- },
- {
- "name": "group",
- "description": "the group name of the virtual machine",
- "type": "string"
- },
- {
- "name": "networkwrite",
- "description": "network write in MiB",
- "type": "string"
- },
- {
- "name": "cpunumber",
- "description": "the number of cpu this virtual machine is running with",
- "type": "integer"
- },
- {
- "name": "memory",
- "description": "the memory allocated for the virtual machine",
- "type": "integer"
- },
- {
- "name": "memorykbs",
- "description": "the memory used by the vm",
- "type": "long"
- },
- {
- "name": "passwordenabled",
- "description": "true if the password rest feature is enabled, false otherwise",
- "type": "boolean"
- },
- {
- "name": "publicip",
- "description": "public IP address id associated with vm via Static nat rule",
- "type": "string"
- },
- {
- "name": "vgpu",
- "description": "the vgpu type used by the virtual machine",
- "type": "string"
- },
- {
- "name": "zoneid",
- "description": "the ID of the availablility zone for the virtual machine",
- "type": "string"
- },
- {
- "name": "state",
- "description": "the state of the virtual machine",
- "type": "string"
- },
- {
- "name": "cpuspeed",
- "description": "the speed of each cpu",
- "type": "integer"
- },
- {
- "name": "isoid",
- "description": "the ID of the ISO attached to the virtual machine",
- "type": "string"
- },
- {
- "name": "networkkbsread",
- "description": "the incoming network traffic on the vm",
- "type": "long"
- },
- {
- "name": "account",
- "description": "the account associated with the virtual machine",
- "type": "string"
- },
- {
- "name": "serviceofferingname",
- "description": "the name of the service offering of the virtual machine",
- "type": "string"
- },
- {
- "name": "servicestate",
- "description": "State of the Service from LB rule",
- "type": "string"
- },
- {
- "name": "cpuused",
- "description": "the amount of the vm's CPU currently used",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the name of the domain in which the virtual machine exists",
- "type": "string"
- },
- {
- "name": "guestosid",
- "description": "Os type ID of the virtual machine",
- "type": "string"
- },
- {
- "name": "rootdeviceid",
- "description": "device ID of the root volume",
- "type": "long"
- },
- {
- "name": "securitygroup",
- "description": "list of security groups associated with the virtual machine",
- "type": "set",
- "response": [
- {
- "name": "domainid",
- "description": "the domain ID of the security group",
- "type": "string"
- },
- {
- "name": "egressrule",
- "description": "the list of egress rules associated with the security group",
- "type": "set",
- "response": [
- {
- "name": "securitygroupname",
- "description": "security group name",
- "type": "string"
- },
- {
- "name": "protocol",
- "description": "the protocol of the security group rule",
- "type": "string"
- },
- {
- "name": "endport",
- "description": "the ending IP of the security group rule ",
- "type": "integer"
- },
- {
- "name": "ruleid",
- "description": "the id of the security group rule",
- "type": "string"
- },
- {
- "name": "icmpcode",
- "description": "the code for the ICMP message response",
- "type": "integer"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated with the rule",
- "type": "set",
- "response": [
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- },
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- }
- ]
- },
- {
- "name": "startport",
- "description": "the starting IP of the security group rule",
- "type": "integer"
- },
- {
- "name": "icmptype",
- "description": "the type of the ICMP message response",
- "type": "integer"
- },
- {
- "name": "account",
- "description": "account owning the security group rule",
- "type": "string"
- },
- {
- "name": "cidr",
- "description": "the CIDR notation for the base IP address of the security group rule",
- "type": "string"
- }
- ]
- },
- {
- "name": "virtualmachineids",
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "type": "set"
- },
- {
- "name": "ingressrule",
- "description": "the list of ingress rules associated with the security group",
- "type": "set",
- "response": [
- {
- "name": "protocol",
- "description": "the protocol of the security group rule",
- "type": "string"
- },
- {
- "name": "securitygroupname",
- "description": "security group name",
- "type": "string"
- },
- {
- "name": "startport",
- "description": "the starting IP of the security group rule",
- "type": "integer"
- },
- {
- "name": "endport",
- "description": "the ending IP of the security group rule ",
- "type": "integer"
- },
- {
- "name": "account",
- "description": "account owning the security group rule",
- "type": "string"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated with the rule",
- "type": "set",
- "response": [
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- },
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- }
- ]
- },
- {
- "name": "cidr",
- "description": "the CIDR notation for the base IP address of the security group rule",
- "type": "string"
- },
- {
- "name": "icmpcode",
- "description": "the code for the ICMP message response",
- "type": "integer"
- },
- {
- "name": "ruleid",
- "description": "the id of the security group rule",
- "type": "string"
- },
- {
- "name": "icmptype",
- "description": "the type of the ICMP message response",
- "type": "integer"
- }
- ]
- },
- {
- "name": "account",
- "description": "the account owning the security group",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain name of the security group",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the ID of the security group",
- "type": "string"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated with the rule",
- "type": "set",
- "response": [
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- }
- ]
- },
- {
- "name": "name",
- "description": "the name of the security group",
- "type": "string"
- },
- {
- "name": "virtualmachinecount",
- "description": "the number of virtualmachines associated with this securitygroup",
- "type": "integer"
- },
- {
- "name": "description",
- "description": "the description of the security group",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name of the group",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id of the group",
- "type": "string"
- }
- ]
- },
- {
- "name": "memoryintfreekbs",
- "description": "the internal memory thats free in vm",
- "type": "long"
- },
- {
- "name": "hypervisor",
- "description": "the hypervisor on which the template runs",
- "type": "string"
- },
- {
- "name": "isoname",
- "description": "the name of the ISO attached to the virtual machine",
- "type": "string"
- },
- {
- "name": "username",
- "description": "the user's name who deployed the virtual machine",
- "type": "string"
- },
- {
- "name": "ipaddress",
- "description": "the VM's primary IP address",
- "type": "string"
- },
- {
- "name": "displayname",
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id of the vm",
- "type": "string"
- },
- {
- "name": "memorytotal",
- "description": "the total memory capacity in GiB",
- "type": "string"
- },
- {
- "name": "keypair",
- "description": "ssh key-pair",
- "type": "string"
- },
- {
- "name": "cputotal",
- "description": "the total cpu capacity in Ghz",
- "type": "string"
- },
- {
- "name": "diskwrite",
- "description": "disk write in MiB",
- "type": "string"
- },
- {
- "name": "templateid",
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "type": "string"
- },
- {
- "name": "password",
- "description": "the password (if exists) of the virtual machine",
- "type": "string"
- },
- {
- "name": "isdynamicallyscalable",
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "type": "boolean"
- },
- {
-
- },
- {
- "name": "name",
- "description": "the name of the virtual machine",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain in which the virtual machine exists",
- "type": "string"
- },
- {
- "name": "networkread",
- "description": "network read in MiB",
- "type": "string"
- },
- {
- "name": "diskread",
- "description": "disk read in MiB",
- "type": "string"
- },
- {
-
- },
- {
- "name": "diskkbswrite",
- "description": "the write (bytes) of disk on the vm",
- "type": "long"
- },
- {
- "name": "diskioread",
- "description": "the read (io) of disk on the vm",
- "type": "long"
- },
- {
- "name": "memorytargetkbs",
- "description": "the target memory in vm",
- "type": "long"
- },
- {
- "name": "affinitygroup",
- "description": "list of affinity groups associated with the virtual machine",
- "type": "set",
- "response": [
- {
- "name": "domain",
- "description": "the domain name of the affinity group",
- "type": "string"
- },
- {
- "name": "type",
- "description": "the type of the affinity group",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name of the affinity group",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project ID of the affinity group",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the domain ID of the affinity group",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the ID of the affinity group",
- "type": "string"
- },
- {
- "name": "name",
- "description": "the name of the affinity group",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account owning the affinity group",
- "type": "string"
- },
- {
- "name": "virtualmachineIds",
- "description": "virtual machine IDs associated with this affinity group",
- "type": "list"
- },
- {
- "name": "description",
- "description": "the description of the affinity group",
- "type": "string"
- }
- ]
- },
- {
- "name": "networkkbswrite",
- "description": "the outgoing network traffic on the host",
- "type": "long"
- },
- {
- "name": "publicipid",
- "description": "public IP address id associated with vm via Static nat rule",
- "type": "string"
- },
- {
- "name": "serviceofferingid",
- "description": "the ID of the service offering of the virtual machine",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the ID of the virtual machine",
- "type": "string"
- },
- {
- "name": "diskofferingid",
- "description": "the ID of the disk offering of the virtual machine",
- "type": "string"
- },
- {
- "name": "zonename",
- "description": "the name of the availability zone for the virtual machine",
- "type": "string"
- },
- {
- "name": "userid",
- "description": "the user's ID who deployed the virtual machine",
- "type": "string"
- },
- {
- "name": "displayvm",
- "description": "an optional field whether to the display the vm to the end user or not.",
- "type": "boolean"
- },
- {
-
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "rootdevicetype",
- "description": "device type of the root volume",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "hostid",
- "description": "the ID of the host for the virtual machine",
- "type": "string"
- },
- {
- "name": "forvirtualnetwork",
- "description": "the virtual network for the service offering",
- "type": "boolean"
- },
- {
- "name": "instancename",
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "type": "string"
- },
- {
- "name": "ostypeid",
- "description": "OS type id of the vm",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name of the vm",
- "type": "string"
- },
- {
- "name": "nic",
- "description": "the list of nics associated with vm",
- "type": "set",
- "response": [
- {
- "name": "ip6cidr",
- "description": "the cidr of IPv6 network",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the ID of the nic",
- "type": "string"
- },
- {
- "name": "broadcasturi",
- "description": "the broadcast uri of the nic",
- "type": "string"
- },
- {
- "name": "networkid",
- "description": "the ID of the corresponding network",
- "type": "string"
- },
- {
- "name": "type",
- "description": "the type of the nic",
- "type": "string"
- },
- {
- "name": "networkname",
- "description": "the name of the corresponding network",
- "type": "string"
- },
- {
- "name": "isdefault",
- "description": "true if nic is default, false otherwise",
- "type": "boolean"
- },
- {
- "name": "nsxlogicalswitch",
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "type": "string"
- },
- {
- "name": "ip6address",
- "description": "the IPv6 address of network",
- "type": "string"
- },
- {
- "name": "virtualmachineid",
- "description": "Id of the vm to which the nic belongs",
- "type": "string"
- },
- {
- "name": "nsxlogicalswitchport",
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "type": "string"
- },
- {
- "name": "netmask",
- "description": "the netmask of the nic",
- "type": "string"
- },
- {
- "name": "gateway",
- "description": "the gateway of the nic",
- "type": "string"
- },
- {
- "name": "macaddress",
- "description": "true if nic is default, false otherwise",
- "type": "string"
- },
- {
- "name": "extradhcpoption",
- "description": "the extra dhcp options on the nic",
- "type": "list"
- },
- {
- "name": "ipaddress",
- "description": "the ip address of the nic",
- "type": "string"
- },
- {
- "name": "traffictype",
- "description": "the traffic type of the nic",
- "type": "string"
- },
- {
- "name": "isolationuri",
- "description": "the isolation uri of the nic",
- "type": "string"
- },
- {
- "name": "ip6gateway",
- "description": "the gateway of IPv6 network",
- "type": "string"
- },
- {
- "name": "secondaryip",
- "description": "the Secondary ipv4 addr of nic",
- "type": "list"
- },
- {
- "name": "deviceid",
- "description": "device id for the network when plugged into the virtual machine",
- "type": "string"
- }
- ]
- },
- {
- "name": "diskkbsread",
- "description": "the read (bytes) of disk on the vm",
- "type": "long"
- },
- {
- "name": "created",
- "description": "the date when this virtual machine was created",
- "type": "date"
- },
- {
- "name": "groupid",
- "description": "the group ID of the virtual machine",
- "type": "string"
- },
- {
- "name": "details",
- "description": "Vm details in key/value pairs.",
- "type": "map"
- },
- {
- "name": "hostname",
- "description": "the name of the host for the virtual machine",
- "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"
},
{
- "name": "deleteStoragePool",
- "description": "Deletes a storage pool.",
- "isasync": false,
- "params": [
- {
- "name": "forced",
- "description": "Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "id",
- "description": "Storage pool id",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,cancelStorageMaintenance,createStoragePool"
- }
- ],
- "response": [
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- },
- {
-
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- },
- {
-
- }
- ]
+ "description": "state of the vpc offering. Can be Disabled/Enabled",
+ "name": "state",
+ "type": "string"
},
{
- "name": "listHosts",
- "description": "Lists hosts.",
- "isasync": false,
- "related": "prepareHostForMaintenance,cancelHostMaintenance,addHost,reconnectHost,addBaremetalHost,updateHost",
- "params": [
- {
- "name": "outofbandmanagementpowerstate",
- "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "page",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "outofbandmanagementenabled",
- "description": "list hosts for which out-of-band management is enabled",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "hypervisor",
- "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "details",
- "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]",
- "type": "list",
- "length": 255,
- "required": false
- },
- {
- "name": "hahost",
- "description": "if true, list only hosts dedicated to HA",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "state",
- "description": "the state of the host",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "keyword",
- "description": "List by keyword",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "type",
- "description": "the host type",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "id",
- "description": "the id of the host",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "prepareHostForMaintenance,cancelHostMaintenance,addHost,reconnectHost,listHosts,addBaremetalHost,updateHost"
- },
- {
- "name": "resourcestate",
- "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]",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "podid",
- "description": "the Pod ID for the host",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listPods,createManagementNetworkIpRange,updatePod"
- },
- {
- "name": "virtualmachineid",
- "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "destroyVirtualMachine,migrateVirtualMachineWithVolume,attachIso,startVirtualMachine,removeNicFromVirtualMachine,updateVirtualMachine,updateVmNicIp,detachIso,rebootVirtualMachine,updateVMAffinityGroup,stopVirtualMachine,detachIso,removeNicFromVirtualMachine,listVirtualMachines,listVirtualMachines,destroyVirtualMachine,attachIso,resetSSHKeyForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,updateDefaultNicForVirtualMachine,assignVirtualMachine,change [...]
- },
- {
- "name": "name",
- "description": "the name of the host",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "clusterid",
- "description": "lists hosts existing in particular cluster",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "addCluster,listClusters,updateCluster"
- },
- {
- "name": "pagesize",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "zoneid",
- "description": "the Zone ID for the host",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createZone,updateZone,listZones,listZones"
- }
- ],
- "response": [
- {
- "name": "clusterid",
- "description": "the cluster ID of the host",
- "type": "string"
- },
- {
- "name": "username",
- "description": "the admin that annotated this host",
- "type": "string"
- },
- {
- "name": "version",
- "description": "the host version",
- "type": "string"
- },
- {
- "name": "cpusockets",
- "description": "the number of CPU sockets on the host",
- "type": "integer"
- },
- {
- "name": "clustertype",
- "description": "the cluster type of the cluster that host belongs to",
- "type": "string"
- },
- {
- "name": "oscategoryname",
- "description": "the OS category name of the host",
- "type": "string"
- },
- {
- "name": "podid",
- "description": "the Pod ID of the host",
- "type": "string"
- },
- {
- "name": "podname",
- "description": "the Pod name of the host",
- "type": "string"
- },
- {
- "name": "memoryallocated",
- "description": "the amount of the host's memory currently allocated",
- "type": "long"
- },
- {
- "name": "clustername",
- "description": "the cluster name of the host",
- "type": "string"
- },
- {
- "name": "capabilities",
- "description": "capabilities of the host",
- "type": "string"
- },
- {
- "name": "annotation",
- "description": "the last annotation set on this host by an admin",
- "type": "string"
- },
- {
- "name": "disconnected",
- "description": "true if the host is disconnected. False otherwise.",
- "type": "date"
- },
- {
- "name": "networkkbswrite",
- "description": "the outgoing network traffic on the host",
- "type": "long"
- },
- {
- "name": "islocalstorageactive",
- "description": "true if local storage is active, false otherwise",
- "type": "boolean"
- },
- {
- "name": "gpugroup",
- "description": "GPU cards present in the host",
- "type": "list",
- "response": [
- {
- "name": "vgpu",
- "description": "the list of enabled vGPUs",
- "type": "list",
- "response": [
- {
- "name": "maxresolutiony",
- "description": "Maximum Y resolution per display",
- "type": "long"
- },
- {
- "name": "maxheads",
- "description": "Maximum displays per user",
- "type": "long"
- },
- {
- "name": "maxresolutionx",
- "description": "Maximum X resolution per display",
- "type": "long"
- },
- {
- "name": "maxvgpuperpgpu",
- "description": "Maximum no. of vgpu per gpu card (pgpu)",
- "type": "long"
- },
- {
- "name": "maxcapacity",
- "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
- "type": "long"
- },
- {
- "name": "remainingcapacity",
- "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
- "type": "long"
- },
- {
- "name": "vgputype",
- "description": "Model Name of vGPU",
- "type": "string"
- },
- {
- "name": "videoram",
- "description": "Video RAM for this vGPU type",
- "type": "long"
- }
- ]
- },
- {
- "name": "gpugroupname",
- "description": "GPU cards present in the host",
- "type": "string"
- }
- ]
- },
- {
- "name": "disksizeallocated",
- "description": "the host's currently allocated disk size",
- "type": "long"
- },
- {
-
- },
- {
- "name": "state",
- "description": "the state of the host",
- "type": "status"
- },
- {
- "name": "networkkbsread",
- "description": "the incoming network traffic on the host",
- "type": "long"
- },
- {
- "name": "hypervisorversion",
- "description": "the hypervisor version",
- "type": "string"
- },
- {
- "name": "cpuallocated",
- "description": "the amount of the host's CPU currently allocated",
- "type": "string"
- },
- {
- "name": "created",
- "description": "the date and time the host was created",
- "type": "date"
- },
- {
- "name": "name",
- "description": "the name of the host",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "zoneid",
- "description": "the Zone ID of the host",
- "type": "string"
- },
- {
- "name": "cpuspeed",
- "description": "the CPU speed of the host",
- "type": "long"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
-
- },
- {
- "name": "zonename",
- "description": "the Zone name of the host",
- "type": "string"
- },
- {
- "name": "hosttags",
- "description": "comma-separated list of tags for the host",
- "type": "string"
- },
- {
- "name": "averageload",
- "description": "the cpu average load on the host",
- "type": "long"
- },
- {
- "name": "hasenoughcapacity",
- "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
- "type": "boolean"
- },
- {
- "name": "cpuused",
- "description": "the amount of the host's CPU currently used",
- "type": "string"
- },
- {
- "name": "memorytotal",
- "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "type": "long"
- },
- {
- "name": "type",
- "description": "the host type",
- "type": "type"
- },
- {
- "name": "events",
- "description": "events available for the host",
- "type": "string"
- },
- {
- "name": "memoryused",
- "description": "the amount of the host's memory currently used",
- "type": "long"
- },
- {
- "name": "memorywithoverprovisioning",
- "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
- "type": "string"
- },
- {
- "name": "cpunumber",
- "description": "the CPU number of the host",
- "type": "integer"
- },
- {
- "name": "id",
- "description": "the ID of the host",
- "type": "string"
- },
- {
- "name": "disksizetotal",
- "description": "the total disk size of the host",
- "type": "long"
- },
- {
- "name": "ipaddress",
- "description": "the IP address of the host",
- "type": "string"
- },
- {
- "name": "lastpinged",
- "description": "the date and time the host was last pinged",
- "type": "date"
- },
- {
- "name": "suitableformigration",
- "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",
- "type": "boolean"
- },
- {
- "name": "hahost",
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "type": "boolean"
- },
- {
- "name": "hypervisor",
- "description": "the host hypervisor",
- "type": "hypervisortype"
- },
- {
- "name": "outofbandmanagement",
- "description": "the host out-of-band management information",
- "type": "outofbandmanagementresponse"
- },
- {
- "name": "oscategoryid",
- "description": "the OS category ID of the host",
- "type": "string"
- },
- {
- "name": "details",
- "description": "Host details in key/value pairs.",
- "type": "map"
- },
- {
- "name": "managementserverid",
- "description": "the management server ID of the host",
- "type": "long"
- },
- {
- "name": "cpuwithoverprovisioning",
- "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ",
- "type": "string"
- },
- {
- "name": "removed",
- "description": "the date and time the host was removed",
- "type": "date"
- },
- {
- "name": "resourcestate",
- "description": "the resource state of the host",
- "type": "string"
- },
- {
- "name": "lastannotated",
- "description": "the last time this host was annotated",
- "type": "date"
- },
- {
- "name": "hostha",
- "description": "the host HA information information",
- "type": "hostharesponse"
- }
- ]
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
{
- "name": "updateStoragePool",
- "description": "Updates a storage pool.",
- "since": "3.0.0",
- "isasync": false,
- "related": "listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,cancelStorageMaintenance,createStoragePool",
- "params": [
- {
- "name": "id",
- "description": "the Id of the storage pool",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,cancelStorageMaintenance,createStoragePool"
- },
- {
- "name": "capacityiops",
- "description": "IOPS CloudStack can provision from this storage pool",
- "type": "long",
- "length": 255,
- "required": false
- },
- {
- "name": "enabled",
- "description": "false to disable the pool for allocation of new volumes, true to enable it back.",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "tags",
- "description": "comma-separated list of tags for the storage pool",
- "type": "list",
- "length": 255,
- "required": false
- },
- {
- "name": "capacitybytes",
- "description": "bytes CloudStack can provision from this storage pool",
- "type": "long",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
- "name": "disksizeallocated",
- "description": "the host's currently allocated disk size",
- "type": "long"
- },
- {
-
- },
- {
- "name": "state",
- "description": "the state of the storage pool",
- "type": "storagepoolstatus"
- },
- {
- "name": "name",
- "description": "the name of the storage pool",
- "type": "string"
- },
- {
- "name": "created",
- "description": "the date and time the storage pool was created",
- "type": "date"
- },
- {
- "name": "disksizetotal",
- "description": "the total disk size of the storage pool",
- "type": "long"
- },
- {
- "name": "overprovisionfactor",
- "description": "the overprovisionfactor for the storage pool",
- "type": "string"
- },
- {
- "name": "clustername",
- "description": "the name of the cluster for the storage pool",
- "type": "string"
- },
- {
- "name": "suitableformigration",
- "description": "true if this pool is suitable to migrate a volume, false otherwise",
- "type": "boolean"
- },
- {
- "name": "disksizeused",
- "description": "the host's currently used disk size",
- "type": "long"
- },
- {
- "name": "zoneid",
- "description": "the Zone ID of the storage pool",
- "type": "string"
- },
- {
-
- },
- {
- "name": "zonename",
- "description": "the Zone name of the storage pool",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "path",
- "description": "the storage pool path",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the ID of the storage pool",
- "type": "string"
- },
- {
- "name": "clusterid",
- "description": "the ID of the cluster for the storage pool",
- "type": "string"
- },
- {
- "name": "tags",
- "description": "the tags for the storage pool",
- "type": "string"
- },
- {
- "name": "allocatediops",
- "description": "total min IOPS currently in use by volumes",
- "type": "long"
- },
- {
- "name": "storagecapabilities",
- "description": "the storage pool capabilities",
- "type": "map"
- },
- {
- "name": "capacityiops",
- "description": "IOPS CloudStack can provision from this storage pool",
- "type": "long"
- },
- {
- "name": "podname",
- "description": "the Pod name of the storage pool",
- "type": "string"
- },
- {
- "name": "provider",
- "description": "Storage provider for this pool",
- "type": "string"
- },
- {
- "name": "podid",
- "description": "the Pod ID of the storage pool",
- "type": "string"
- },
- {
- "name": "scope",
- "description": "the scope of the storage pool",
- "type": "string"
- },
- {
- "name": "hypervisor",
- "description": "the hypervisor type of the storage pool",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "type",
- "description": "the storage pool type",
- "type": "string"
- },
- {
- "name": "ipaddress",
- "description": "the IP address of the storage pool",
- "type": "string"
- }
- ]
+ "description": " indicates if the vpc offering supports distributed router for one-hop forwarding",
+ "name": "distributedvpcrouter",
+ "type": "boolean"
},
{
- "name": "rebootSystemVm",
- "description": "Reboots a system VM.",
- "isasync": true,
- "related": "stopSystemVm,migrateSystemVm,changeServiceForSystemVm,startSystemVm,destroySystemVm,listSystemVms,scaleSystemVm",
- "params": [
- {
- "name": "id",
- "description": "The ID of the system virtual machine",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "stopSystemVm,rebootSystemVm,migrateSystemVm,changeServiceForSystemVm,startSystemVm,destroySystemVm,listSystemVms,scaleSystemVm"
- }
- ],
- "response": [
- {
- "name": "name",
- "description": "the name of the system VM",
- "type": "string"
- },
- {
- "name": "podid",
- "description": "the Pod ID for the system VM",
- "type": "string"
- },
- {
-
- },
- {
- "name": "privateip",
- "description": "the private IP address for the system VM",
- "type": "string"
- },
- {
- "name": "gateway",
- "description": "the gateway for the system VM",
- "type": "string"
- },
- {
- "name": "dns1",
- "description": "the first DNS for the system VM",
- "type": "string"
- },
- {
- "name": "created",
- "description": "the date and time the system VM was created",
- "type": "date"
- },
- {
- "name": "publicmacaddress",
- "description": "the public MAC address for the system VM",
- "type": "string"
- },
- {
- "name": "hostname",
- "description": "the hostname for the system VM",
- "type": "string"
- },
- {
- "name": "systemvmtype",
- "description": "the system VM type",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "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.",
- "type": "integer"
- },
- {
- "name": "zonename",
- "description": "the Zone name for the system VM",
- "type": "string"
- },
- {
- "name": "publicvlan",
- "description": "public vlan range",
- "type": "list"
- },
- {
- "name": "publicnetmask",
- "description": "the public netmask for the system VM",
- "type": "string"
- },
- {
- "name": "hypervisor",
- "description": "the hypervisor on which the template runs",
- "type": "string"
- },
- {
- "name": "state",
- "description": "the state of the system VM",
- "type": "string"
- },
- {
-
- },
- {
- "name": "dns2",
- "description": "the second DNS for the system VM",
- "type": "string"
- },
- {
- "name": "linklocalip",
- "description": "the link local IP address for the system vm",
- "type": "string"
- },
- {
- "name": "zoneid",
- "description": "the Zone ID for the system VM",
- "type": "string"
- },
- {
- "name": "activeviewersessions",
- "description": "the number of active console sessions for the console proxy system vm",
- "type": "integer"
- },
- {
- "name": "jobid",
- "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.",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "networkdomain",
- "description": "the network domain for the system VM",
- "type": "string"
- },
- {
- "name": "linklocalnetmask",
- "description": "the link local netmask for the system vm",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the ID of the system VM",
- "type": "string"
- },
- {
- "name": "guestvlan",
- "description": "guest vlan range",
- "type": "string"
- },
- {
- "name": "privatemacaddress",
- "description": "the private MAC address for the system VM",
- "type": "string"
- },
- {
- "name": "publicip",
- "description": "the public IP address for the system VM",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "templateid",
- "description": "the template ID for the system VM",
- "type": "string"
- },
- {
- "name": "hostid",
- "description": "the host ID for the system VM",
- "type": "string"
- },
- {
- "name": "privatenetmask",
- "description": "the private netmask for the system VM",
- "type": "string"
- },
- {
- "name": "linklocalmacaddress",
- "description": "the link local MAC address for the system vm",
- "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": "Creates a new Pod.",
+ "isasync": false,
+ "name": "createPod",
+ "params": [
+ {
+ "description": "Allocation state of this Pod for allocation of new resources",
+ "length": 255,
+ "name": "allocationstate",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the netmask for the Pod",
+ "length": 255,
+ "name": "netmask",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the gateway for the Pod",
+ "length": 255,
+ "name": "gateway",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the ending IP address for the Pod",
+ "length": 255,
+ "name": "endip",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the starting IP address for the Pod",
+ "length": 255,
+ "name": "startip",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID in which the Pod will be created",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "the name of the Pod",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "response": [
+ {
+ "description": "the Zone name of the Pod",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP for the Pod",
+ "name": "startip",
+ "type": "list"
+ },
+ {
+ "description": "the ID of the Pod",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "indicates Vlan ID for the range",
+ "name": "vlanid",
+ "type": "list"
+ },
+ {
+ "description": "the capacity of the Pod",
+ "name": "capacity",
+ "response": [
+ {
+ "description": "the capacity currently in allocated",
+ "name": "capacityallocated",
+ "type": "long"
+ },
+ {
+ "description": "the capacity type",
+ "name": "type",
+ "type": "short"
+ },
+ {
+ "description": "the Zone ID",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the Cluster ID",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the Cluster name",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the capacity currently in use",
+ "name": "capacityused",
+ "type": "long"
+ },
+ {
+ "description": "the Pod ID",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the percentage of capacity currently in use",
+ "name": "percentused",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
+ },
+ {
+ "description": "the capacity name",
+ "name": "name",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the netmask of the Pod",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID of the Pod",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the ending IP for the Pod",
+ "name": "endip",
+ "type": "list"
+ },
+ {
+ "description": "indicates if range is dedicated for CPVM and SSVM",
+ "name": "forsystemvms",
+ "type": "list"
+ },
+ {
+ "description": "the allocation state of the Pod",
+ "name": "allocationstate",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Pod",
+ "name": "name",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the gateway of the Pod",
+ "name": "gateway",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "Creates an account from an LDAP user",
+ "isasync": false,
+ "name": "ldapCreateAccount",
+ "params": [
+ {
+ "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
+ "length": 255,
+ "name": "accounttype",
+ "required": false,
+ "type": "short"
},
{
- "name": "importLdapUsers",
- "description": "Import LDAP users",
- "since": "4.3.0",
- "isasync": false,
- "related": "searchLdap,listLdapUsers",
- "params": [
- {
- "name": "account",
- "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "keyword",
- "description": "List by keyword",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "timezone",
- "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "pagesize",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "page",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "group",
- "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.",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "accounttype",
- "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
- "type": "short",
- "length": 255,
- "required": false
- },
- {
- "name": "roleid",
- "description": "Creates the account under the specified role.",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "updateRole,createRole,listRoles"
- },
- {
- "name": "accountdetails",
- "description": "details for account used to store specific parameters",
- "type": "map",
- "length": 255,
- "required": false
- },
- {
- "name": "domainid",
- "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",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listDomains,listDomains,listDomainChildren,updateDomain,createDomain"
- }
- ],
- "response": [
- {
-
- },
- {
- "name": "firstname",
- "description": "The user's firstname",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "email",
- "description": "The user's email",
- "type": "string"
- },
- {
- "name": "principal",
- "description": "The user's principle",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "domain",
- "description": "The user's domain",
- "type": "string"
- },
- {
- "name": "username",
- "description": "The user's username",
- "type": "string"
- },
- {
-
- },
- {
- "name": "lastname",
- "description": "The user's lastname",
- "type": "string"
- }
- ]
+ "description": "Unique username.",
+ "length": 255,
+ "name": "username",
+ "required": true,
+ "type": "string"
},
{
- "name": "listDedicatedZones",
- "description": "List dedicated zones.",
- "isasync": false,
- "related": "dedicateZone",
- "params": [
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the zone",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listDomains,listDomains,listDomainChildren,updateDomain,createDomain"
- },
- {
- "name": "zoneid",
- "description": "the ID of the Zone",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createZone,updateZone,listZones,listZones"
- },
- {
- "name": "keyword",
- "description": "List by keyword",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "pagesize",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "page",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "account",
- "description": "the name of the account associated with the zone. Must be used with domainId.",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "affinitygroupid",
- "description": "list dedicated zones by affinity group",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createAffinityGroup,listAffinityGroups"
- }
- ],
- "response": [
- {
-
- },
- {
- "name": "accountid",
- "description": "the Account Id to which the Zone is dedicated",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the ID of the dedicated resource",
- "type": "string"
- },
- {
-
- },
- {
- "name": "affinitygroupid",
- "description": "the Dedication Affinity Group ID of the zone",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "zonename",
- "description": "the Name of the Zone",
- "type": "string"
- },
- {
- "name": "zoneid",
- "description": "the ID of the Zone",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the domain ID to which the Zone is dedicated",
- "type": "string"
- }
- ]
+ "description": "details for account used to store specific parameters",
+ "length": 255,
+ "name": "accountdetails",
+ "required": false,
+ "type": "map"
},
{
- "name": "listNetworks",
- "description": "Lists all available networks.",
- "isasync": false,
- "related": "listPaloAltoFirewallNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listBrocadeVcsDeviceNetworks,updateNetwork,listNetworks,updateNetwork,createNetwork,createNetwork",
- "params": [
- {
- "name": "keyword",
- "description": "List by keyword",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "account",
- "description": "list resources by account. Must be used with the domainId parameter.",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "listall",
- "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",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "restartrequired",
- "description": "list networks by restartRequired",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "canusefordeploy",
- "description": "list networks available for VM deployment",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "vpcid",
- "description": "List networks by VPC",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "migrateVPC,listVPCs,updateVPC,listVPCs,createVPC,restartVPC,createVPC,updateVPC"
- },
- {
- "name": "forvpc",
- "description": "the network belongs to VPC",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "physicalnetworkid",
- "description": "list networks by physical network id",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "updatePhysicalNetwork,createPhysicalNetwork,listPhysicalNetworks"
- },
- {
- "name": "supportedservices",
- "description": "list networks supporting certain services",
- "type": "list",
- "length": 255,
- "required": false
- },
- {
- "name": "id",
- "description": "list networks by ID",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listPaloAltoFirewallNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listBrocadeVcsDeviceNetworks,listNetworks,updateNetwork,listNetworks,updateNetwork,createNetwork,createNetwork"
- },
- {
- "name": "specifyipranges",
- "description": "true if need to list only networks which support specifying IP ranges",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "tags",
- "description": "List resources by tags (key/value pairs)",
- "type": "map",
- "length": 255,
- "required": false
- },
- {
- "name": "traffictype",
- "description": "type of the traffic",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "displaynetwork",
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
- "type": "boolean",
- "length": 255,
- "required": false,
- "since": "4.4"
- },
- {
- "name": "type",
- "description": "the type of the network. Supported values are: isolated and shared",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "zoneid",
- "description": "the zone ID of the network",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createZone,updateZone,listZones,listZones"
- },
- {
- "name": "isrecursive",
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "page",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "issystem",
- "description": "true if network is system, false otherwise",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "acltype",
- "description": "list networks by ACL (access control list) type. Supported values are account and domain",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "pagesize",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "projectid",
- "description": "list objects by project",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listProjectAccounts,listProjects,activateProject,createProject,updateProject,suspendProject"
- },
- {
- "name": "domainid",
- "description": "list only resources belonging to the domain specified",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listDomains,listDomains,listDomainChildren,updateDomain,createDomain"
- }
- ],
- "response": [
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "project",
- "description": "the project name of the address",
- "type": "string"
- },
- {
- "name": "networkofferingdisplaytext",
- "description": "display text of the network offering the network is created from",
- "type": "string"
- },
- {
- "name": "externalid",
- "description": "The external id of the network",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the domain id of the network owner",
- "type": "string"
- },
- {
- "name": "dns1",
- "description": "the first DNS for the network",
- "type": "string"
- },
- {
- "name": "zonename",
- "description": "the name of the zone the network belongs to",
- "type": "string"
- },
- {
- "name": "netmask",
- "description": "the network's netmask",
- "type": "string"
- },
- {
- "name": "ip6cidr",
- "description": "the cidr of IPv6 network",
- "type": "string"
- },
- {
- "name": "related",
- "description": "related to what other network configuration",
- "type": "string"
- },
- {
- "name": "cidr",
- "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
- "type": "string"
- },
- {
- "name": "vpcid",
- "description": "VPC the network belongs to",
- "type": "string"
- },
- {
-
- },
- {
- "name": "networkofferingid",
- "description": "network offering id the network is created from",
- "type": "string"
- },
- {
- "name": "networkofferingavailability",
- "description": "availability of the network offering the network is created from",
- "type": "string"
- },
- {
- "name": "type",
- "description": "the type of the network",
- "type": "string"
- },
- {
- "name": "physicalnetworkid",
- "description": "the physical network id",
- "type": "string"
- },
- {
- "name": "displaynetwork",
- "description": "an optional field, whether to the display the network to the end user or not.",
- "type": "boolean"
- },
- {
- "name": "aclid",
- "description": "ACL Id associated with the VPC network",
- "type": "string"
- },
- {
- "name": "zoneid",
- "description": "zone id of the network",
- "type": "string"
- },
- {
- "name": "zonesnetworkspans",
- "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
- "type": "set"
- },
- {
- "name": "acltype",
- "description": "acl type - access type to the network",
- "type": "string"
- },
- {
- "name": "redundantrouter",
- "description": "If the network has redundant routers enabled",
- "type": "boolean"
- },
- {
- "name": "displaytext",
- "description": "the displaytext of the network",
- "type": "string"
- },
- {
- "name": "service",
- "description": "the list of services",
- "type": "list",
- "response": [
- {
- "name": "name",
- "description": "the service name",
- "type": "string"
- },
- {
- "name": "provider",
- "description": "the service provider name",
- "type": "list",
- "response": [
- {
- "name": "canenableindividualservice",
- "description": "true if individual services can be enabled/disabled",
- "type": "boolean"
- },
- {
- "name": "name",
- "description": "the provider name",
- "type": "string"
- },
- {
- "name": "id",
- "description": "uuid of the network provider",
- "type": "string"
- },
- {
- "name": "servicelist",
- "description": "services for this provider",
- "type": "list"
- },
- {
- "name": "state",
- "description": "state of the network provider",
- "type": "string"
- },
- {
- "name": "destinationphysicalnetworkid",
- "description": "the destination physical network",
- "type": "string"
- },
- {
- "name": "physicalnetworkid",
- "description": "the physical network this belongs to",
- "type": "string"
- }
- ]
- },
- {
- "name": "capability",
- "description": "the list of capabilities",
- "type": "list",
- "response": [
- {
- "name": "canchooseservicecapability",
- "description": "can this service capability value can be choosable while creatine network offerings",
- "type": "boolean"
- },
- {
- "name": "name",
- "description": "the capability name",
- "type": "string"
- },
- {
- "name": "value",
- "description": "the capability value",
- "type": "string"
- }
- ]
- }
- ]
- },
- {
- "name": "domain",
- "description": "the domain name of the network owner",
- "type": "string"
- },
- {
- "name": "issystem",
- "description": "true if network is system, false otherwise",
- "type": "boolean"
- },
- {
- "name": "networkofferingname",
- "description": "name of the network offering the network is created from",
- "type": "string"
- },
- {
- "name": "subdomainaccess",
- "description": "true if users from subdomains can access the domain level network",
- "type": "boolean"
- },
- {
- "name": "dns2",
- "description": "the second DNS for the network",
- "type": "string"
- },
- {
- "name": "broadcasturi",
- "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
- "type": "string"
- },
- {
- "name": "vlan",
- "description": "The vlan of the network. This parameter is visible to ROOT admins only",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the id of the network",
- "type": "string"
- },
- {
- "name": "broadcastdomaintype",
- "description": "Broadcast domain type of the network",
- "type": "string"
- },
- {
- "name": "ispersistent",
- "description": "list networks that are persistent",
- "type": "boolean"
- },
- {
- "name": "projectid",
- "description": "the project id of the ipaddress",
- "type": "string"
- },
- {
- "name": "name",
- "description": "the name of the network",
- "type": "string"
- },
- {
- "name": "reservediprange",
- "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
- "type": "string"
- },
- {
- "name": "gateway",
- "description": "the network's gateway",
- "type": "string"
- },
- {
- "name": "specifyipranges",
- "description": "true if network supports specifying ip ranges, false otherwise",
- "type": "boolean"
- },
- {
-
- },
- {
- "name": "ip6gateway",
- "description": "the gateway of IPv6 network",
- "type": "string"
- },
- {
- "name": "traffictype",
- "description": "the traffic type of the network",
- "type": "string"
- },
- {
- "name": "networkofferingconservemode",
- "description": "true if network offering is ip conserve mode enabled",
- "type": "boolean"
- },
- {
- "name": "networkcidr",
- "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE",
- "type": "string"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated with network",
- "type": "list",
- "response": [
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- }
- ]
- },
- {
- "name": "account",
- "description": "the owner of the network",
- "type": "string"
- },
- {
- "name": "canusefordeploy",
- "description": "list networks available for vm deployment",
- "type": "boolean"
- },
- {
- "name": "strechedl2subnet",
- "description": "true if network can span multiple zones",
- "type": "boolean"
- },
- {
- "name": "isdefault",
- "description": "true if network is default, false otherwise",
- "type": "boolean"
- },
- {
- "name": "restartrequired",
- "description": "true network requires restart",
- "type": "boolean"
- },
- {
- "name": "state",
- "description": "state of the network",
- "type": "string"
- },
- {
- "name": "networkdomain",
- "description": "the network domain",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- }
- ]
+ "description": "Account UUID, required for adding account from external provisioning system",
+ "length": 255,
+ "name": "accountid",
+ "required": false,
+ "type": "string"
},
{
- "name": "listElastistorPool",
- "description": "Lists the pools of elastistor",
- "isasync": false,
- "related": "",
- "params": [
- {
- "name": "id",
- "description": "the ID of the Pool",
- "type": "long",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
- "name": "gateway",
- "description": "default gateway of the pool",
- "type": "string"
- },
- {
- "name": "maxiops",
- "description": "available iops of the pool",
- "type": "long"
- },
- {
-
- },
- {
- "name": "name",
- "description": "the name of the storage pool",
- "type": "string"
- },
- {
- "name": "state",
- "description": "the state of the storage pool",
- "type": "string"
- },
- {
- "name": "size",
- "description": "the current available space of the pool",
- "type": "long"
- },
- {
- "name": "controllerid",
- "description": "controller of the pool",
- "type": "string"
- },
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "id",
- "description": "the ID of the storage pool",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- }
- ]
- },
- {
- "name": "updateFirewallRule",
- "description": "Updates firewall rule ",
- "since": "4.4",
- "isasync": true,
- "related": "updateEgressFirewallRule,listFirewallRules,createEgressFirewallRule,listEgressFirewallRules,createFirewallRule",
- "params": [
- {
- "name": "customid",
- "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
- "type": "string",
- "length": 255,
- "required": false,
- "since": "4.4"
- },
- {
- "name": "fordisplay",
- "description": "an optional field, whether to the display the rule to the end user or not",
- "type": "boolean",
- "length": 255,
- "required": false,
- "since": "4.4"
- },
- {
- "name": "id",
- "description": "the ID of the firewall rule",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "createIpForwardingRule,listPortForwardingRules,updatePortForwardingRule,createPortForwardingRule,listIpForwardingRules"
- }
- ],
- "response": [
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "protocol",
- "description": "the protocol of the firewall rule",
- "type": "string"
- },
- {
-
- },
- {
- "name": "networkid",
- "description": "the network id of the firewall rule",
- "type": "string"
- },
- {
- "name": "endport",
- "description": "the ending port of firewall rule's port range",
- "type": "integer"
- },
- {
- "name": "startport",
- "description": "the starting port of firewall rule's port range",
- "type": "integer"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
-
- },
- {
- "name": "icmpcode",
- "description": "error code for this icmp message",
- "type": "integer"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated with the rule",
- "type": "list",
- "response": [
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- }
- ]
- },
- {
- "name": "cidrlist",
- "description": "the cidr list to forward traffic from",
- "type": "string"
- },
- {
- "name": "ipaddress",
- "description": "the public ip address for the firewall rule",
- "type": "string"
- },
- {
- "name": "destcidrlist",
- "description": "the cidr list to forward traffic to",
- "type": "string"
- },
- {
- "name": "state",
- "description": "the state of the rule",
- "type": "string"
- },
- {
- "name": "icmptype",
- "description": "type of the icmp message being sent",
- "type": "integer"
- },
- {
- "name": "id",
- "description": "the ID of the firewall rule",
- "type": "string"
- },
- {
- "name": "ipaddressid",
- "description": "the public ip address id for the firewall rule",
- "type": "string"
- },
- {
- "name": "fordisplay",
- "description": "is rule for display to the regular user",
- "type": "boolean"
- }
- ]
+ "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
+ "length": 255,
+ "name": "timezone",
+ "required": false,
+ "type": "string"
},
{
- "name": "quotaIsEnabled",
- "description": "Return true if the plugin is enabled",
- "since": "4.7.0",
- "isasync": false,
- "related": "",
- "params": [
-
- ],
- "response": [
- {
- "name": "isenabled",
- "description": "is quota service enabled",
- "type": "boolean"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
-
- },
- {
-
- }
- ]
+ "description": "Creates the user under the specified domain.",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
},
{
- "name": "listHypervisors",
- "description": "List hypervisors",
- "isasync": false,
- "related": "",
- "params": [
- {
- "name": "zoneid",
- "description": "the zone id for listing hypervisors.",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createZone,updateZone,listZones,listZones"
- }
- ],
- "response": [
- {
- "name": "name",
- "description": "Hypervisor name",
- "type": "string"
- },
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
-
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- }
- ]
+ "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
},
{
- "name": "deleteAccountFromProject",
- "description": "Deletes account from the project",
- "since": "3.0.0",
- "isasync": true,
- "params": [
- {
- "name": "account",
- "description": "name of the account to be removed from the project",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "projectid",
- "description": "ID of the project to remove the account from",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "listProjectAccounts,listProjects,activateProject,createProject,updateProject,suspendProject"
- }
- ],
- "response": [
- {
-
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- },
- {
-
- }
- ]
+ "description": "Creates the account under the specified role.",
+ "length": 255,
+ "name": "roleid",
+ "related": "createRole,importRole,listRoles,updateRole",
+ "required": false,
+ "type": "uuid"
},
{
- "name": "updateGuestOs",
- "description": "Updates the information about Guest OS",
- "since": "4.4.0",
- "isasync": true,
- "related": "addGuestOs,listOsTypes",
- "params": [
- {
- "name": "id",
- "description": "UUID of the Guest OS",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "addGuestOs,updateGuestOs,listOsTypes"
- },
- {
- "name": "details",
- "description": "Map of (key/value pairs)",
- "type": "map",
- "length": 255,
- "required": true
- },
- {
- "name": "osdisplayname",
- "description": "Unique display name for Guest OS",
- "type": "string",
- "length": 255,
- "required": true
- }
- ],
- "response": [
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "description",
- "description": "the name/description of the OS type",
- "type": "string"
- },
- {
- "name": "oscategoryid",
- "description": "the ID of the OS category",
- "type": "string"
- },
- {
- "name": "isuserdefined",
- "description": "is the guest OS user defined",
- "type": "boolean"
- },
- {
- "name": "id",
- "description": "the ID of the OS type",
- "type": "string"
- },
- {
-
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- }
- ]
+ "description": "Network domain for the account's networks",
+ "length": 255,
+ "name": "networkdomain",
+ "required": false,
+ "type": "string"
},
{
- "name": "updateResourceLimit",
- "description": "Updates resource limits for an account or domain.",
- "isasync": false,
- "related": "listResourceLimits",
- "params": [
- {
- "name": "resourcetype",
- "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. [...]
- "type": "integer",
- "length": 255,
- "required": true
- },
- {
- "name": "account",
- "description": "Update resource for a specified account. Must be used with the domainId parameter.",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "projectid",
- "description": "Update resource limits for project",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listProjectAccounts,listProjects,activateProject,createProject,updateProject,suspendProject"
- },
- {
- "name": "domainid",
- "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.",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listDomains,listDomains,listDomainChildren,updateDomain,createDomain"
- },
- {
- "name": "max",
- "description": " Maximum resource limit.",
- "type": "long",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
- "name": "projectid",
- "description": "the project id of the resource limit",
- "type": "string"
- },
- {
-
- },
- {
-
- },
- {
- "name": "account",
- "description": "the account of the resource limit",
- "type": "string"
- },
- {
- "name": "max",
- "description": "the maximum number of the resource. A -1 means the resource currently has no limit.",
- "type": "long"
- },
- {
- "name": "domainid",
- "description": "the domain ID of the resource limit",
- "type": "string"
- },
- {
- "name": "resourcetypename",
- "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.",
- "type": "string"
- },
- {
- "name": "resourcetype",
- "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.",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain name of the resource limit",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name of the resource limit",
- "type": "string"
- }
- ]
+ "description": "User UUID, required for adding account from external provisioning system",
+ "length": 255,
+ "name": "userid",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts",
+ "response": [
+ {
+ "description": "the total memory (in MB) the account can own",
+ "name": "memorylimit",
+ "type": "string"
},
{
- "name": "deleteStaticRoute",
- "description": "Deletes a static route",
- "isasync": true,
- "params": [
- {
- "name": "id",
- "description": "the ID of the static route",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "listStaticRoutes,createStaticRoute"
- }
- ],
- "response": [
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
-
- },
- {
-
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- }
- ]
+ "description": "the state of the account",
+ "name": "state",
+ "type": "string"
},
{
- "name": "listHostsMetrics",
- "description": "Lists hosts metrics",
- "since": "4.9.3",
- "isasync": false,
- "related": "",
- "params": [
- {
- "name": "state",
- "description": "the state of the host",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "hahost",
- "description": "if true, list only hosts dedicated to HA",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "virtualmachineid",
- "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "destroyVirtualMachine,migrateVirtualMachineWithVolume,attachIso,startVirtualMachine,removeNicFromVirtualMachine,updateVirtualMachine,updateVmNicIp,detachIso,rebootVirtualMachine,updateVMAffinityGroup,stopVirtualMachine,detachIso,removeNicFromVirtualMachine,listVirtualMachines,listVirtualMachines,destroyVirtualMachine,attachIso,resetSSHKeyForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,updateDefaultNicForVirtualMachine,assignVirtualMachine,change [...]
- },
- {
- "name": "id",
- "description": "the id of the host",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "prepareHostForMaintenance,cancelHostMaintenance,addHost,reconnectHost,addBaremetalHost,updateHost"
- },
- {
- "name": "outofbandmanagementenabled",
- "description": "list hosts for which out-of-band management is enabled",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "type",
- "description": "the host type",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "name",
- "description": "the name of the host",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "keyword",
- "description": "List by keyword",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "zoneid",
- "description": "the Zone ID for the host",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createZone,updateZone,listZones,listZones"
- },
- {
- "name": "podid",
- "description": "the Pod ID for the host",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listPods,createManagementNetworkIpRange,updatePod"
- },
- {
- "name": "resourcestate",
- "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]",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "outofbandmanagementpowerstate",
- "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "clusterid",
- "description": "lists hosts existing in particular cluster",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "addCluster,listClusters,updateCluster"
- },
- {
- "name": "details",
- "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]",
- "type": "list",
- "length": 255,
- "required": false
- },
- {
- "name": "hypervisor",
- "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "pagesize",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "page",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
- "name": "averageload",
- "description": "the cpu average load on the host",
- "type": "long"
- },
- {
- "name": "cpuspeed",
- "description": "the CPU speed of the host",
- "type": "long"
- },
- {
- "name": "memorytotal",
- "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "type": "long"
- },
- {
- "name": "zoneid",
- "description": "the Zone ID of the host",
- "type": "string"
- },
- {
- "name": "capabilities",
- "description": "capabilities of the host",
- "type": "string"
- },
- {
- "name": "networkkbswrite",
- "description": "the outgoing network traffic on the host",
- "type": "long"
- },
- {
- "name": "memoryallocatedthreshold",
- "description": "memory allocated notification threshold exceeded",
- "type": "boolean"
- },
- {
- "name": "memoryusedgb",
- "description": "the total cpu used in GiB",
- "type": "string"
- },
- {
- "name": "cpuallocated",
- "description": "the amount of the host's CPU currently allocated",
- "type": "string"
- },
- {
- "name": "hypervisorversion",
- "description": "the hypervisor version",
- "type": "string"
- },
- {
- "name": "clustername",
- "description": "the cluster name of the host",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the ID of the host",
- "type": "string"
- },
- {
- "name": "events",
- "description": "events available for the host",
- "type": "string"
- },
- {
- "name": "podid",
- "description": "the Pod ID of the host",
- "type": "string"
- },
- {
- "name": "zonename",
- "description": "the Zone name of the host",
- "type": "string"
- },
- {
- "name": "outofbandmanagement",
- "description": "the host out-of-band management information",
- "type": "outofbandmanagementresponse"
- },
- {
- "name": "memorythreshold",
- "description": "memory usage notification threshold exceeded",
- "type": "boolean"
- },
- {
- "name": "memoryallocated",
- "description": "the amount of the host's memory currently allocated",
- "type": "long"
- },
- {
- "name": "suitableformigration",
- "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",
- "type": "boolean"
- },
- {
- "name": "powerstate",
- "description": "out-of-band management power state",
- "type": "powerstate"
- },
- {
- "name": "cpuusedghz",
- "description": "the total cpu used in Ghz",
- "type": "string"
- },
- {
- "name": "networkwrite",
- "description": "network write in GiB",
- "type": "string"
- },
- {
- "name": "disconnected",
- "description": "true if the host is disconnected. False otherwise.",
- "type": "date"
- },
- {
-
- },
- {
- "name": "details",
- "description": "Host details in key/value pairs.",
- "type": "map"
- },
- {
-
- },
- {
- "name": "type",
- "description": "the host type",
- "type": "type"
- },
- {
- "name": "resourcestate",
- "description": "the resource state of the host",
- "type": "string"
- },
- {
- "name": "oscategoryid",
- "description": "the OS category ID of the host",
- "type": "string"
- },
- {
- "name": "clustertype",
- "description": "the cluster type of the cluster that host belongs to",
- "type": "string"
- },
- {
- "name": "cputhreshold",
- "description": "cpu usage notification threshold exceeded",
- "type": "boolean"
- },
- {
- "name": "cpunumber",
- "description": "the CPU number of the host",
- "type": "integer"
- },
- {
- "name": "hostha",
- "description": "the host HA information information",
- "type": "hostharesponse"
- },
- {
- "name": "clusterid",
- "description": "the cluster ID of the host",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "memoryallocateddisablethreshold",
- "description": "memory allocated disable threshold exceeded",
- "type": "boolean"
- },
- {
- "name": "memorywithoverprovisioning",
- "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
- "type": "string"
- },
- {
- "name": "hahost",
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "type": "boolean"
- },
- {
- "name": "cpuallocatedghz",
- "description": "the total cpu allocated in Ghz",
- "type": "string"
- },
- {
- "name": "cpuused",
- "description": "the amount of the host's CPU currently used",
- "type": "string"
- },
- {
- "name": "hypervisor",
- "description": "the host hypervisor",
- "type": "hypervisortype"
- },
- {
- "name": "hasenoughcapacity",
- "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
- "type": "boolean"
- },
- {
- "name": "networkread",
- "description": "network read in GiB",
- "type": "string"
- },
- {
- "name": "disksizeallocated",
- "description": "the host's currently allocated disk size",
- "type": "long"
- },
- {
- "name": "cpusockets",
- "description": "the number of CPU sockets on the host",
- "type": "integer"
- },
- {
- "name": "oscategoryname",
- "description": "the OS category name of the host",
- "type": "string"
- },
- {
- "name": "gpugroup",
- "description": "GPU cards present in the host",
- "type": "list",
- "response": [
- {
- "name": "gpugroupname",
- "description": "GPU cards present in the host",
- "type": "string"
- },
- {
- "name": "vgpu",
- "description": "the list of enabled vGPUs",
- "type": "list",
- "response": [
- {
- "name": "remainingcapacity",
- "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
- "type": "long"
- },
- {
- "name": "vgputype",
- "description": "Model Name of vGPU",
- "type": "string"
- },
- {
- "name": "maxheads",
- "description": "Maximum displays per user",
- "type": "long"
- },
- {
- "name": "maxresolutionx",
- "description": "Maximum X resolution per display",
- "type": "long"
- },
- {
- "name": "maxresolutiony",
- "description": "Maximum Y resolution per display",
- "type": "long"
- },
- {
- "name": "videoram",
- "description": "Video RAM for this vGPU type",
- "type": "long"
- },
- {
- "name": "maxcapacity",
- "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
- "type": "long"
- },
- {
- "name": "maxvgpuperpgpu",
- "description": "Maximum no. of vgpu per gpu card (pgpu)",
- "type": "long"
- }
- ]
- }
- ]
- },
- {
- "name": "memorytotalgb",
- "description": "the total cpu capacity in GiB",
- "type": "string"
- },
- {
- "name": "hosttags",
- "description": "comma-separated list of tags for the host",
- "type": "string"
- },
- {
- "name": "removed",
- "description": "the date and time the host was removed",
- "type": "date"
- },
- {
- "name": "memorydisablethreshold",
- "description": "memory usage disable threshold exceeded",
- "type": "boolean"
- },
- {
- "name": "version",
- "description": "the host version",
- "type": "string"
- },
- {
- "name": "networkkbsread",
- "description": "the incoming network traffic on the host",
- "type": "long"
- },
- {
- "name": "cpuwithoverprovisioning",
- "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ",
- "type": "string"
- },
- {
- "name": "lastannotated",
- "description": "the last time this host was annotated",
- "type": "date"
- },
- {
- "name": "cputotalghz",
- "description": "the total cpu capacity in Ghz",
- "type": "string"
- },
- {
- "name": "state",
- "description": "the state of the host",
- "type": "status"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "managementserverid",
- "description": "the management server ID of the host",
- "type": "long"
- },
- {
- "name": "created",
- "description": "the date and time the host was created",
- "type": "date"
- },
- {
- "name": "cpudisablethreshold",
- "description": "cpu usage disable threshold exceeded",
- "type": "boolean"
- },
- {
- "name": "ipaddress",
- "description": "the IP address of the host",
- "type": "string"
- },
- {
- "name": "lastpinged",
- "description": "the date and time the host was last pinged",
- "type": "date"
- },
- {
- "name": "cpuallocateddisablethreshold",
- "description": "cpu allocated disable threshold exceeded",
- "type": "boolean"
- },
- {
- "name": "podname",
- "description": "the Pod name of the host",
- "type": "string"
- },
- {
- "name": "islocalstorageactive",
- "description": "true if local storage is active, false otherwise",
- "type": "boolean"
- },
- {
- "name": "disksizetotal",
- "description": "the total disk size of the host",
- "type": "long"
- },
- {
- "name": "cpuallocatedthreshold",
- "description": "cpu allocated notification threshold exceeded",
- "type": "boolean"
- },
- {
- "name": "memoryallocatedgb",
- "description": "the total cpu allocated in GiB",
- "type": "string"
- },
- {
- "name": "name",
- "description": "the name of the host",
- "type": "string"
- },
- {
- "name": "instances",
- "description": "instances on the host",
- "type": "string"
- },
- {
- "name": "memoryused",
- "description": "the amount of the host's memory currently used",
- "type": "long"
- },
- {
- "name": "annotation",
- "description": "the last annotation set on this host by an admin",
- "type": "string"
- },
- {
- "name": "username",
- "description": "the admin that annotated this host",
- "type": "string"
- }
- ]
+ "description": "the total number of public ip addresses this account can acquire",
+ "name": "iplimit",
+ "type": "string"
},
{
- "name": "releaseDedicatedPod",
- "description": "Release the dedication for the pod",
- "isasync": true,
- "params": [
- {
- "name": "podid",
- "description": "the ID of the Pod",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "listPods,createManagementNetworkIpRange,updatePod"
- }
- ],
- "response": [
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- },
- {
-
- },
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
-
- }
- ]
+ "description": "the total secondary storage space (in GiB) the account can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
},
{
- "name": "listAffinityGroups",
- "description": "Lists affinity groups",
- "isasync": false,
- "related": "createAffinityGroup",
- "params": [
- {
- "name": "isrecursive",
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "listall",
- "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",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "virtualmachineid",
- "description": "lists affinity groups by virtual machine ID",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "destroyVirtualMachine,migrateVirtualMachineWithVolume,attachIso,startVirtualMachine,removeNicFromVirtualMachine,updateVirtualMachine,updateVmNicIp,detachIso,rebootVirtualMachine,updateVMAffinityGroup,stopVirtualMachine,detachIso,removeNicFromVirtualMachine,listVirtualMachines,listVirtualMachines,destroyVirtualMachine,attachIso,resetSSHKeyForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,updateDefaultNicForVirtualMachine,assignVirtualMachine,change [...]
- },
- {
- "name": "name",
- "description": "lists affinity groups by name",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "page",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "id",
- "description": "list the affinity group by the ID provided",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createAffinityGroup,listAffinityGroups"
- },
- {
- "name": "type",
- "description": "lists affinity groups by type",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "pagesize",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "keyword",
- "description": "List by keyword",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "domainid",
- "description": "list only resources belonging to the domain specified",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listDomains,listDomains,listDomainChildren,updateDomain,createDomain"
- },
- {
- "name": "projectid",
- "description": "list objects by project",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listProjectAccounts,listProjects,activateProject,createProject,updateProject,suspendProject"
- },
- {
- "name": "account",
- "description": "list resources by account. Must be used with the domainId parameter.",
- "type": "string",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
-
- },
- {
- "name": "name",
- "description": "the name of the affinity group",
- "type": "string"
- },
- {
-
- },
- {
- "name": "id",
- "description": "the ID of the affinity group",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the domain ID of the affinity group",
- "type": "string"
- },
- {
- "name": "type",
- "description": "the type of the affinity group",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain name of the affinity group",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "project",
- "description": "the project name of the affinity group",
- "type": "string"
- },
- {
- "name": "virtualmachineIds",
- "description": "virtual machine IDs associated with this affinity group",
- "type": "list"
- },
- {
- "name": "projectid",
- "description": "the project ID of the affinity group",
- "type": "string"
- },
- {
- "name": "description",
- "description": "the description of the affinity group",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account owning the affinity group",
- "type": "string"
- }
- ]
+ "description": "the total volume available for this account",
+ "name": "volumeavailable",
+ "type": "string"
},
{
- "name": "registerSSHKeyPair",
- "description": "Register a public key in a keypair under a certain name",
- "isasync": false,
- "related": "listSSHKeyPairs",
- "params": [
- {
- "name": "name",
- "description": "Name of the keypair",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "publickey",
- "description": "Public key material of the keypair",
- "type": "string",
- "length": 5120,
- "required": true
- },
- {
- "name": "projectid",
- "description": "an optional project for the ssh key",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listProjectAccounts,listProjects,activateProject,createProject,updateProject,suspendProject"
- },
- {
- "name": "domainid",
- "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listDomains,listDomains,listDomainChildren,updateDomain,createDomain"
- },
- {
- "name": "account",
- "description": "an optional account for the ssh key. Must be used with domainId.",
- "type": "string",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "fingerprint",
- "description": "Fingerprint of the public key",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain name of the keypair owner",
- "type": "string"
- },
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "name",
- "description": "Name of the keypair",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the owner of the keypair",
- "type": "string"
- },
- {
-
- },
- {
- "name": "domainid",
- "description": "the domain id of the keypair owner",
- "type": "string"
- }
- ]
+ "description": "the total number of vpcs owned by account",
+ "name": "vpctotal",
+ "type": "long"
},
{
- "name": "deleteRemoteAccessVpn",
- "description": "Destroys a l2tp/ipsec remote access vpn",
- "isasync": true,
- "params": [
- {
- "name": "publicipid",
- "description": "public ip address id of the vpn server",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "restartNetwork,updateIpAddress,listPublicIpAddresses,associateIpAddress,associateIpAddress,listPublicIpAddresses"
- }
- ],
- "response": [
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- },
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- },
- {
-
- },
- {
-
- }
- ]
+ "description": "name of the Domain the account belongs to",
+ "name": "domain",
+ "type": "string"
},
{
- "name": "updateNetworkACLList",
- "description": "Updates network ACL list",
- "since": "4.4",
- "isasync": true,
- "params": [
- {
- "name": "customid",
- "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
- "type": "string",
- "length": 255,
- "required": false,
- "since": "4.4"
- },
- {
- "name": "fordisplay",
- "description": "an optional field, whether to the display the list to the end user or not",
- "type": "boolean",
- "length": 255,
- "required": false,
- "since": "4.4"
- },
- {
- "name": "id",
- "description": "the ID of the network ACL",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "createNetworkACLList,listNetworkACLLists"
- },
- {
- "name": "description",
- "description": "Description of the network ACL list",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "name",
- "description": "Name of the network ACL list",
- "type": "string",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
-
- },
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
-
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- }
- ]
+ "description": "the total number of virtual machines deployed by this account",
+ "name": "vmtotal",
+ "type": "long"
},
{
- "name": "deleteNiciraNvpDevice",
- "description": " delete a nicira nvp device",
- "isasync": true,
- "params": [
- {
- "name": "nvpdeviceid",
- "description": "Nicira device ID",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "addNiciraNvpDevice,listNiciraNvpDevices"
- }
- ],
- "response": [
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
-
- },
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- }
- ]
- },
- {
- "name": "restoreVirtualMachine",
- "description": "Restore a VM to original template/ISO or new template/ISO",
- "since": "3.0.0",
- "isasync": true,
- "related": "destroyVirtualMachine,migrateVirtualMachineWithVolume,attachIso,startVirtualMachine,removeNicFromVirtualMachine,updateVirtualMachine,updateVmNicIp,detachIso,rebootVirtualMachine,updateVMAffinityGroup,stopVirtualMachine,detachIso,removeNicFromVirtualMachine,listVirtualMachines,listVirtualMachines,destroyVirtualMachine,attachIso,resetSSHKeyForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,updateDefaultNicForVirtualMachine,assignVirtualMachine,changeServiceF [...]
- "params": [
- {
- "name": "virtualmachineid",
- "description": "Virtual Machine ID",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "destroyVirtualMachine,migrateVirtualMachineWithVolume,attachIso,startVirtualMachine,removeNicFromVirtualMachine,updateVirtualMachine,updateVmNicIp,detachIso,rebootVirtualMachine,updateVMAffinityGroup,stopVirtualMachine,detachIso,removeNicFromVirtualMachine,listVirtualMachines,listVirtualMachines,destroyVirtualMachine,attachIso,resetSSHKeyForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,updateDefaultNicForVirtualMachine,assignVirtualMachine,change [...]
- },
- {
- "name": "templateid",
- "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",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "updateTemplate,listIsos,createTemplate,listTemplates,registerTemplate,registerIso,registerTemplate,prepareTemplate,copyTemplate,createTemplate,updateIso,listIsos,copyTemplate,copyIso,registerIso,listTemplates"
- }
- ],
- "response": [
- {
- "name": "cpuspeed",
- "description": "the speed of each cpu",
- "type": "integer"
- },
- {
- "name": "isdynamicallyscalable",
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "type": "boolean"
- },
- {
- "name": "memorykbs",
- "description": "the memory used by the vm",
- "type": "long"
- },
- {
- "name": "haenable",
- "description": "true if high-availability is enabled, false otherwise",
- "type": "boolean"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated",
- "type": "set",
- "response": [
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- }
- ]
- },
- {
- "name": "diskofferingid",
- "description": "the ID of the disk offering of the virtual machine",
- "type": "string"
- },
- {
- "name": "displayname",
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "type": "string"
- },
- {
- "name": "securitygroup",
- "description": "list of security groups associated with the virtual machine",
- "type": "set",
- "response": [
- {
- "name": "tags",
- "description": "the list of resource tags associated with the rule",
- "type": "set",
- "response": [
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- }
- ]
- },
- {
- "name": "projectid",
- "description": "the project id of the group",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account owning the security group",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain name of the security group",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the domain ID of the security group",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name of the group",
- "type": "string"
- },
- {
- "name": "description",
- "description": "the description of the security group",
- "type": "string"
- },
- {
- "name": "ingressrule",
- "description": "the list of ingress rules associated with the security group",
- "type": "set",
- "response": [
- {
- "name": "cidr",
- "description": "the CIDR notation for the base IP address of the security group rule",
- "type": "string"
- },
- {
- "name": "icmpcode",
- "description": "the code for the ICMP message response",
- "type": "integer"
- },
- {
- "name": "securitygroupname",
- "description": "security group name",
- "type": "string"
- },
- {
- "name": "icmptype",
- "description": "the type of the ICMP message response",
- "type": "integer"
- },
- {
- "name": "account",
- "description": "account owning the security group rule",
- "type": "string"
- },
- {
- "name": "ruleid",
- "description": "the id of the security group rule",
- "type": "string"
- },
- {
- "name": "startport",
- "description": "the starting IP of the security group rule",
- "type": "integer"
- },
- {
- "name": "protocol",
- "description": "the protocol of the security group rule",
- "type": "string"
- },
- {
- "name": "endport",
- "description": "the ending IP of the security group rule ",
- "type": "integer"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated with the rule",
- "type": "set",
- "response": [
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- },
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- }
- ]
- }
- ]
- },
- {
- "name": "virtualmachineids",
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "type": "set"
- },
- {
- "name": "virtualmachinecount",
- "description": "the number of virtualmachines associated with this securitygroup",
- "type": "integer"
- },
- {
- "name": "egressrule",
- "description": "the list of egress rules associated with the security group",
- "type": "set",
- "response": [
- {
- "name": "icmptype",
- "description": "the type of the ICMP message response",
- "type": "integer"
- },
- {
- "name": "securitygroupname",
- "description": "security group name",
- "type": "string"
- },
- {
- "name": "endport",
- "description": "the ending IP of the security group rule ",
- "type": "integer"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated with the rule",
- "type": "set",
- "response": [
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- },
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- }
- ]
- },
- {
- "name": "protocol",
- "description": "the protocol of the security group rule",
- "type": "string"
- },
- {
- "name": "ruleid",
- "description": "the id of the security group rule",
- "type": "string"
- },
- {
- "name": "cidr",
- "description": "the CIDR notation for the base IP address of the security group rule",
- "type": "string"
- },
- {
- "name": "startport",
- "description": "the starting IP of the security group rule",
- "type": "integer"
- },
- {
- "name": "icmpcode",
- "description": "the code for the ICMP message response",
- "type": "integer"
- },
- {
- "name": "account",
- "description": "account owning the security group rule",
- "type": "string"
- }
- ]
- },
- {
- "name": "name",
- "description": "the name of the security group",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the ID of the security group",
- "type": "string"
- }
- ]
- },
- {
- "name": "diskioread",
- "description": "the read (io) of disk on the vm",
- "type": "long"
- },
- {
- "name": "state",
- "description": "the state of the virtual machine",
- "type": "string"
- },
- {
- "name": "templatename",
- "description": "the name of the template for the virtual machine",
- "type": "string"
- },
- {
- "name": "diskkbsread",
- "description": "the read (bytes) of disk on the vm",
- "type": "long"
- },
- {
- "name": "passwordenabled",
- "description": "true if the password rest feature is enabled, false otherwise",
- "type": "boolean"
- },
- {
- "name": "instancename",
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "type": "string"
- },
- {
- "name": "hostid",
- "description": "the ID of the host for the virtual machine",
- "type": "string"
- },
- {
- "name": "displayvm",
- "description": "an optional field whether to the display the vm to the end user or not.",
- "type": "boolean"
- },
- {
- "name": "isodisplaytext",
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "type": "string"
- },
- {
- "name": "zonename",
- "description": "the name of the availability zone for the virtual machine",
- "type": "string"
- },
- {
- "name": "serviceofferingname",
- "description": "the name of the service offering of the virtual machine",
- "type": "string"
- },
- {
- "name": "zoneid",
- "description": "the ID of the availablility zone for the virtual machine",
- "type": "string"
- },
- {
- "name": "userid",
- "description": "the user's ID who deployed the virtual machine",
- "type": "string"
- },
- {
- "name": "nic",
- "description": "the list of nics associated with vm",
- "type": "set",
- "response": [
- {
- "name": "ip6address",
- "description": "the IPv6 address of network",
- "type": "string"
- },
- {
- "name": "ipaddress",
- "description": "the ip address of the nic",
- "type": "string"
- },
- {
- "name": "deviceid",
- "description": "device id for the network when plugged into the virtual machine",
- "type": "string"
- },
- {
- "name": "type",
- "description": "the type of the nic",
- "type": "string"
- },
- {
- "name": "virtualmachineid",
- "description": "Id of the vm to which the nic belongs",
- "type": "string"
- },
- {
- "name": "nsxlogicalswitchport",
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "type": "string"
- },
- {
- "name": "isolationuri",
- "description": "the isolation uri of the nic",
- "type": "string"
- },
- {
- "name": "networkid",
- "description": "the ID of the corresponding network",
- "type": "string"
- },
- {
- "name": "ip6gateway",
- "description": "the gateway of IPv6 network",
- "type": "string"
- },
- {
- "name": "nsxlogicalswitch",
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the ID of the nic",
- "type": "string"
- },
- {
- "name": "netmask",
- "description": "the netmask of the nic",
- "type": "string"
- },
- {
- "name": "gateway",
- "description": "the gateway of the nic",
- "type": "string"
- },
- {
- "name": "ip6cidr",
- "description": "the cidr of IPv6 network",
- "type": "string"
- },
- {
- "name": "secondaryip",
- "description": "the Secondary ipv4 addr of nic",
- "type": "list"
- },
- {
- "name": "traffictype",
- "description": "the traffic type of the nic",
- "type": "string"
- },
- {
- "name": "macaddress",
- "description": "true if nic is default, false otherwise",
- "type": "string"
- },
- {
- "name": "networkname",
- "description": "the name of the corresponding network",
- "type": "string"
- },
- {
- "name": "isdefault",
- "description": "true if nic is default, false otherwise",
- "type": "boolean"
- },
- {
- "name": "broadcasturi",
- "description": "the broadcast uri of the nic",
- "type": "string"
- },
- {
- "name": "extradhcpoption",
- "description": "the extra dhcp options on the nic",
- "type": "list"
- }
- ]
- },
- {
- "name": "serviceofferingid",
- "description": "the ID of the service offering of the virtual machine",
- "type": "string"
- },
- {
- "name": "forvirtualnetwork",
- "description": "the virtual network for the service offering",
- "type": "boolean"
- },
- {
- "name": "group",
- "description": "the group name of the virtual machine",
- "type": "string"
- },
- {
-
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "memorytargetkbs",
- "description": "the target memory in vm",
- "type": "long"
- },
- {
-
- },
- {
- "name": "hostname",
- "description": "the name of the host for the virtual machine",
- "type": "string"
- },
- {
- "name": "hypervisor",
- "description": "the hypervisor on which the template runs",
- "type": "string"
- },
- {
- "name": "cpunumber",
- "description": "the number of cpu this virtual machine is running with",
- "type": "integer"
- },
- {
- "name": "diskiowrite",
- "description": "the write (io) of disk on the vm",
- "type": "long"
- },
- {
- "name": "keypair",
- "description": "ssh key-pair",
- "type": "string"
- },
- {
- "name": "networkkbsread",
- "description": "the incoming network traffic on the vm",
- "type": "long"
- },
- {
- "name": "memoryintfreekbs",
- "description": "the internal memory thats free in vm",
- "type": "long"
- },
- {
- "name": "diskkbswrite",
- "description": "the write (bytes) of disk on the vm",
- "type": "long"
- },
- {
- "name": "account",
- "description": "the account associated with the virtual machine",
- "type": "string"
- },
- {
- "name": "diskofferingname",
- "description": "the name of the disk offering of the virtual machine",
- "type": "string"
- },
- {
- "name": "publicipid",
- "description": "public IP address id associated with vm via Static nat rule",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the ID of the virtual machine",
- "type": "string"
- },
- {
- "name": "networkkbswrite",
- "description": "the outgoing network traffic on the host",
- "type": "long"
- },
- {
- "name": "created",
- "description": "the date when this virtual machine was created",
- "type": "date"
- },
- {
- "name": "templatedisplaytext",
- "description": " an alternate display text of the template for the virtual machine",
- "type": "string"
- },
- {
- "name": "publicip",
- "description": "public IP address id associated with vm via Static nat rule",
- "type": "string"
- },
- {
- "name": "vgpu",
- "description": "the vgpu type used by the virtual machine",
- "type": "string"
- },
- {
- "name": "rootdevicetype",
- "description": "device type of the root volume",
- "type": "string"
- },
- {
- "name": "ostypeid",
- "description": "OS type id of the vm",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id of the vm",
- "type": "string"
- },
- {
- "name": "name",
- "description": "the name of the virtual machine",
- "type": "string"
- },
- {
-
- },
- {
- "name": "domainid",
- "description": "the ID of the domain in which the virtual machine exists",
- "type": "string"
- },
- {
- "name": "groupid",
- "description": "the group ID of the virtual machine",
- "type": "string"
- },
- {
- "name": "templateid",
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the name of the domain in which the virtual machine exists",
- "type": "string"
- },
- {
- "name": "guestosid",
- "description": "Os type ID of the virtual machine",
- "type": "string"
- },
- {
- "name": "details",
- "description": "Vm details in key/value pairs.",
- "type": "map"
- },
- {
- "name": "affinitygroup",
- "description": "list of affinity groups associated with the virtual machine",
- "type": "set",
- "response": [
- {
- "name": "type",
- "description": "the type of the affinity group",
- "type": "string"
- },
- {
- "name": "name",
- "description": "the name of the affinity group",
- "type": "string"
- },
- {
- "name": "description",
- "description": "the description of the affinity group",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the ID of the affinity group",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project ID of the affinity group",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name of the affinity group",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account owning the affinity group",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the domain ID of the affinity group",
- "type": "string"
- },
- {
- "name": "virtualmachineIds",
- "description": "virtual machine IDs associated with this affinity group",
- "type": "list"
- },
- {
- "name": "domain",
- "description": "the domain name of the affinity group",
- "type": "string"
- }
- ]
- },
- {
- "name": "cpuused",
- "description": "the amount of the vm's CPU currently used",
- "type": "string"
- },
- {
- "name": "password",
- "description": "the password (if exists) of the virtual machine",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name of the vm",
- "type": "string"
- },
- {
- "name": "isoname",
- "description": "the name of the ISO attached to the virtual machine",
- "type": "string"
- },
- {
- "name": "memory",
- "description": "the memory allocated for the virtual machine",
- "type": "integer"
- },
- {
- "name": "servicestate",
- "description": "State of the Service from LB rule",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "isoid",
- "description": "the ID of the ISO attached to the virtual machine",
- "type": "string"
- },
- {
- "name": "rootdeviceid",
- "description": "device ID of the root volume",
- "type": "long"
- },
- {
- "name": "username",
- "description": "the user's name who deployed the virtual machine",
- "type": "string"
- }
- ]
+ "description": "the total number of snapshots stored by this account",
+ "name": "snapshottotal",
+ "type": "long"
},
{
- "name": "deleteEvents",
- "description": "Delete one or more events.",
- "isasync": false,
- "params": [
- {
- "name": "startdate",
- "description": "start date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
- "type": "date",
- "length": 255,
- "required": false
- },
- {
- "name": "ids",
- "description": "the IDs of the events",
- "type": "list",
- "length": 255,
- "required": false,
- "related": "listEvents"
- },
- {
- "name": "enddate",
- "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
- "type": "date",
- "length": 255,
- "required": false
- },
- {
- "name": "type",
- "description": "delete by event type",
- "type": "string",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
-
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
-
- }
- ]
+ "description": "id of the Domain the account belongs to",
+ "name": "domainid",
+ "type": "string"
},
{
- "name": "getVolumeSnapshotDetails",
- "description": "Get Volume Snapshot Details",
- "isasync": false,
- "related": "getVolumeiScsiName",
- "params": [
- {
- "name": "snapshotid",
- "description": "CloudStack Snapshot UUID",
- "type": "string",
- "length": 255,
- "required": true
- }
- ],
- "response": [
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "volumeiScsiName",
- "description": "Volume iSCSI Name",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
-
- }
- ]
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
},
{
- "name": "listUcsBlades",
- "description": "List ucs blades",
- "isasync": false,
- "related": "associateUcsProfileToBlade",
- "params": [
- {
- "name": "pagesize",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "keyword",
- "description": "List by keyword",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "ucsmanagerid",
- "description": "ucs manager id",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "listUcsManagers,addUcsManager"
- },
- {
- "name": "page",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
- "name": "id",
- "description": "ucs blade id",
- "type": "string"
- },
- {
- "name": "profiledn",
- "description": "associated ucs profile dn",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "ucsmanagerid",
- "description": "ucs manager id",
- "type": "string"
- },
- {
- "name": "bladedn",
- "description": "ucs blade dn",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
-
- },
- {
-
- },
- {
- "name": "hostid",
- "description": "cloudstack host id this blade associates to",
- "type": "string"
- }
- ]
+ "description": "the total number of cpu cores available to be created for this account",
+ "name": "cpuavailable",
+ "type": "string"
},
{
- "name": "notifyBaremetalProvisionDone",
- "description": "Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user",
- "isasync": true,
- "params": [
- {
- "name": "mac",
- "description": "mac of the nic used for provision",
- "type": "object",
- "length": 255,
- "required": true
- }
- ],
- "response": [
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- },
- {
-
- },
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- }
- ]
+ "description": "the total number of projects available for administration by this account",
+ "name": "projectavailable",
+ "type": "string"
},
{
- "name": "deleteIso",
- "description": "Deletes an ISO file.",
- "isasync": true,
- "params": [
- {
- "name": "id",
- "description": "the ID of the ISO file",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "updateTemplate,listIsos,createTemplate,listTemplates,registerTemplate,registerIso,registerTemplate,prepareTemplate,copyTemplate,createTemplate,updateIso,listIsos,copyTemplate,copyIso,registerIso,listTemplates"
- },
- {
- "name": "zoneid",
- "description": "the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createZone,updateZone,listZones,listZones"
- }
- ],
- "response": [
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- },
- {
-
- }
- ]
+ "description": "the total number of cpu cores the account can own",
+ "name": "cpulimit",
+ "type": "string"
},
{
- "name": "updateHost",
- "description": "Updates a host.",
- "isasync": false,
- "related": "prepareHostForMaintenance,cancelHostMaintenance,addHost,reconnectHost,addBaremetalHost",
- "params": [
- {
- "name": "url",
- "description": "the new uri for the secondary storage: nfs://host/path",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "allocationstate",
- "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "hosttags",
- "description": "list of tags to be added to the host",
- "type": "list",
- "length": 255,
- "required": false
- },
- {
- "name": "id",
- "description": "the ID of the host to update",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "prepareHostForMaintenance,cancelHostMaintenance,addHost,reconnectHost,addBaremetalHost,updateHost"
- },
- {
- "name": "oscategoryid",
- "description": "the id of Os category to update the host with",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listOsCategories"
- },
- {
- "name": "annotation",
- "description": "Add an annotation to this host",
- "type": "string",
- "length": 255,
- "required": false,
- "since": "4.11"
- }
- ],
- "response": [
- {
- "name": "zoneid",
- "description": "the Zone ID of the host",
- "type": "string"
- },
- {
- "name": "podname",
- "description": "the Pod name of the host",
- "type": "string"
- },
- {
- "name": "clustername",
- "description": "the cluster name of the host",
- "type": "string"
- },
- {
- "name": "details",
- "description": "Host details in key/value pairs.",
- "type": "map"
- },
- {
- "name": "oscategoryid",
- "description": "the OS category ID of the host",
- "type": "string"
- },
- {
- "name": "cpusockets",
- "description": "the number of CPU sockets on the host",
- "type": "integer"
- },
- {
- "name": "ipaddress",
- "description": "the IP address of the host",
- "type": "string"
- },
- {
- "name": "podid",
- "description": "the Pod ID of the host",
- "type": "string"
- },
- {
- "name": "annotation",
- "description": "the last annotation set on this host by an admin",
- "type": "string"
- },
- {
- "name": "hostha",
- "description": "the host HA information information",
- "type": "hostharesponse"
- },
- {
- "name": "clusterid",
- "description": "the cluster ID of the host",
- "type": "string"
- },
- {
- "name": "oscategoryname",
- "description": "the OS category name of the host",
- "type": "string"
- },
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "name",
- "description": "the name of the host",
- "type": "string"
- },
- {
- "name": "lastannotated",
- "description": "the last time this host was annotated",
- "type": "date"
- },
- {
- "name": "version",
- "description": "the host version",
- "type": "string"
- },
- {
- "name": "cpuwithoverprovisioning",
- "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ",
- "type": "string"
- },
- {
- "name": "cpunumber",
- "description": "the CPU number of the host",
- "type": "integer"
- },
- {
- "name": "clustertype",
- "description": "the cluster type of the cluster that host belongs to",
- "type": "string"
- },
- {
- "name": "hahost",
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "type": "boolean"
- },
- {
- "name": "memorywithoverprovisioning",
- "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
- "type": "string"
- },
- {
- "name": "cpuused",
- "description": "the amount of the host's CPU currently used",
- "type": "string"
- },
- {
- "name": "memoryused",
- "description": "the amount of the host's memory currently used",
- "type": "long"
- },
- {
- "name": "id",
- "description": "the ID of the host",
- "type": "string"
- },
- {
- "name": "state",
- "description": "the state of the host",
- "type": "status"
- },
- {
- "name": "hasenoughcapacity",
- "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
- "type": "boolean"
- },
- {
- "name": "hypervisor",
- "description": "the host hypervisor",
- "type": "hypervisortype"
- },
- {
- "name": "memoryallocated",
- "description": "the amount of the host's memory currently allocated",
- "type": "long"
- },
- {
- "name": "capabilities",
- "description": "capabilities of the host",
- "type": "string"
- },
- {
- "name": "resourcestate",
- "description": "the resource state of the host",
- "type": "string"
- },
- {
- "name": "averageload",
- "description": "the cpu average load on the host",
- "type": "long"
- },
- {
- "name": "cpuallocated",
- "description": "the amount of the host's CPU currently allocated",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "disksizeallocated",
- "description": "the host's currently allocated disk size",
- "type": "long"
- },
- {
- "name": "events",
- "description": "events available for the host",
- "type": "string"
- },
- {
- "name": "created",
- "description": "the date and time the host was created",
- "type": "date"
- },
- {
- "name": "zonename",
- "description": "the Zone name of the host",
- "type": "string"
- },
- {
- "name": "removed",
- "description": "the date and time the host was removed",
- "type": "date"
- },
- {
- "name": "managementserverid",
- "description": "the management server ID of the host",
- "type": "long"
- },
- {
- "name": "cpuspeed",
- "description": "the CPU speed of the host",
- "type": "long"
- },
- {
- "name": "memorytotal",
- "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "type": "long"
- },
- {
- "name": "disconnected",
- "description": "true if the host is disconnected. False otherwise.",
- "type": "date"
- },
- {
- "name": "outofbandmanagement",
- "description": "the host out-of-band management information",
- "type": "outofbandmanagementresponse"
- },
- {
- "name": "type",
- "description": "the host type",
- "type": "type"
- },
- {
- "name": "username",
- "description": "the admin that annotated this host",
- "type": "string"
- },
- {
- "name": "hosttags",
- "description": "comma-separated list of tags for the host",
- "type": "string"
- },
- {
- "name": "networkkbswrite",
- "description": "the outgoing network traffic on the host",
- "type": "long"
- },
- {
- "name": "disksizetotal",
- "description": "the total disk size of the host",
- "type": "long"
- },
- {
- "name": "islocalstorageactive",
- "description": "true if local storage is active, false otherwise",
- "type": "boolean"
- },
- {
- "name": "hypervisorversion",
- "description": "the hypervisor version",
- "type": "string"
- },
- {
- "name": "networkkbsread",
- "description": "the incoming network traffic on the host",
- "type": "long"
- },
- {
- "name": "gpugroup",
- "description": "GPU cards present in the host",
- "type": "list",
- "response": [
- {
- "name": "vgpu",
- "description": "the list of enabled vGPUs",
- "type": "list",
- "response": [
- {
- "name": "vgputype",
- "description": "Model Name of vGPU",
- "type": "string"
- },
- {
- "name": "maxheads",
- "description": "Maximum displays per user",
- "type": "long"
- },
- {
- "name": "maxvgpuperpgpu",
- "description": "Maximum no. of vgpu per gpu card (pgpu)",
- "type": "long"
- },
- {
- "name": "maxresolutiony",
- "description": "Maximum Y resolution per display",
- "type": "long"
- },
- {
- "name": "remainingcapacity",
- "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
- "type": "long"
- },
- {
- "name": "maxresolutionx",
- "description": "Maximum X resolution per display",
- "type": "long"
- },
- {
- "name": "maxcapacity",
- "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
- "type": "long"
- },
- {
- "name": "videoram",
- "description": "Video RAM for this vGPU type",
- "type": "long"
- }
- ]
- },
- {
- "name": "gpugroupname",
- "description": "GPU cards present in the host",
- "type": "string"
- }
- ]
- },
- {
- "name": "suitableformigration",
- "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",
- "type": "boolean"
- },
- {
-
- },
- {
- "name": "lastpinged",
- "description": "the date and time the host was last pinged",
- "type": "date"
- }
- ]
+ "description": "the total number of projects the account can own",
+ "name": "projectlimit",
+ "type": "string"
},
{
- "name": "createEgressFirewallRule",
- "description": "Creates a egress firewall rule for a given network ",
- "isasync": true,
- "related": "updateEgressFirewallRule,listFirewallRules,listEgressFirewallRules,createFirewallRule",
- "params": [
- {
- "name": "type",
- "description": "type of firewallrule: system/user",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "destcidrlist",
- "description": "the cidr list to forward traffic to",
- "type": "list",
- "length": 255,
- "required": false
- },
- {
- "name": "icmpcode",
- "description": "error code for this icmp message",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "cidrlist",
- "description": "the cidr list to forward traffic from",
- "type": "list",
- "length": 255,
- "required": false
- },
- {
- "name": "icmptype",
- "description": "type of the icmp message being sent",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "protocol",
- "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "startport",
- "description": "the starting port of firewall rule",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "fordisplay",
- "description": "an optional field, whether to the display the rule to the end user or not",
- "type": "boolean",
- "length": 255,
- "required": false,
- "since": "4.4"
- },
- {
- "name": "networkid",
- "description": "the network id of the port forwarding rule",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "listPaloAltoFirewallNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listBrocadeVcsDeviceNetworks,updateNetwork,listNetworks,updateNetwork,createNetwork,createNetwork"
- },
- {
- "name": "endport",
- "description": "the ending port of firewall rule",
- "type": "integer",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
- "name": "destcidrlist",
- "description": "the cidr list to forward traffic to",
- "type": "string"
- },
- {
- "name": "networkid",
- "description": "the network id of the firewall rule",
- "type": "string"
- },
- {
-
- },
- {
- "name": "icmptype",
- "description": "type of the icmp message being sent",
- "type": "integer"
- },
- {
- "name": "startport",
- "description": "the starting port of firewall rule's port range",
- "type": "integer"
- },
- {
-
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated with the rule",
- "type": "list",
- "response": [
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- },
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- }
- ]
- },
- {
- "name": "icmpcode",
- "description": "error code for this icmp message",
- "type": "integer"
- },
- {
- "name": "ipaddress",
- "description": "the public ip address for the firewall rule",
- "type": "string"
- },
- {
- "name": "endport",
- "description": "the ending port of firewall rule's port range",
- "type": "integer"
- },
- {
- "name": "state",
- "description": "the state of the rule",
- "type": "string"
- },
- {
- "name": "cidrlist",
- "description": "the cidr list to forward traffic from",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "id",
- "description": "the ID of the firewall rule",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "protocol",
- "description": "the protocol of the firewall rule",
- "type": "string"
- },
- {
- "name": "ipaddressid",
- "description": "the public ip address id for the firewall rule",
- "type": "string"
- },
- {
- "name": "fordisplay",
- "description": "is rule for display to the regular user",
- "type": "boolean"
- }
- ]
+ "description": "the total number of vpcs available to be created for this account",
+ "name": "vpcavailable",
+ "type": "string"
},
{
- "name": "getSolidFireVolumeSize",
- "description": "Get the SF volume size including Hypervisor Snapshot Reserve",
- "isasync": false,
- "related": "",
- "params": [
- {
- "name": "volumeid",
- "description": "Volume UUID",
- "type": "string",
- "length": 255,
- "required": true
- }
- ],
- "response": [
- {
-
- },
- {
- "name": "solidFireVolumeSize",
- "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve",
- "type": "long"
- },
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- }
- ]
+ "description": "the total number of snapshots available for this account",
+ "name": "snapshotavailable",
+ "type": "string"
},
{
- "name": "listVPCOfferings",
- "description": "Lists VPC offerings",
- "isasync": false,
- "related": "updateVPCOffering",
- "params": [
- {
- "name": "supportedservices",
- "description": "list VPC offerings supporting certain services",
- "type": "list",
- "length": 255,
- "required": false
- },
- {
- "name": "displaytext",
- "description": "list VPC offerings by display text",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "page",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "pagesize",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "state",
- "description": "list VPC offerings by state",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "keyword",
- "description": "List by keyword",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "id",
- "description": "list VPC offerings by id",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "updateVPCOffering,listVPCOfferings"
- },
- {
- "name": "name",
- "description": "list VPC offerings by name",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "isdefault",
- "description": "true if need to list only default VPC offerings. Default value is false",
- "type": "boolean",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
- "name": "supportsregionLevelvpc",
- "description": " indicated if the offering can support region level vpc",
- "type": "boolean"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
-
- },
- {
- "name": "id",
- "description": "the id of the vpc offering",
- "type": "string"
- },
- {
- "name": "service",
- "description": "the list of supported services",
- "type": "list",
- "response": [
- {
- "name": "capability",
- "description": "the list of capabilities",
- "type": "list",
- "response": [
- {
- "name": "value",
- "description": "the capability value",
- "type": "string"
- },
- {
- "name": "canchooseservicecapability",
- "description": "can this service capability value can be choosable while creatine network offerings",
- "type": "boolean"
- },
- {
- "name": "name",
- "description": "the capability name",
- "type": "string"
- }
- ]
- },
- {
- "name": "provider",
- "description": "the service provider name",
- "type": "list",
- "response": [
- {
- "name": "physicalnetworkid",
- "description": "the physical network this belongs to",
- "type": "string"
- },
- {
- "name": "servicelist",
- "description": "services for this provider",
- "type": "list"
- },
- {
- "name": "name",
- "description": "the provider name",
- "type": "string"
- },
- {
- "name": "destinationphysicalnetworkid",
- "description": "the destination physical network",
- "type": "string"
- },
- {
- "name": "state",
- "description": "state of the network provider",
- "type": "string"
- },
- {
- "name": "canenableindividualservice",
- "description": "true if individual services can be enabled/disabled",
- "type": "boolean"
- },
- {
- "name": "id",
- "description": "uuid of the network provider",
- "type": "string"
- }
- ]
- },
- {
- "name": "name",
- "description": "the service name",
- "type": "string"
- }
- ]
- },
- {
- "name": "created",
- "description": "the date this vpc offering was created",
- "type": "date"
- },
- {
- "name": "displaytext",
- "description": "an alternate display text of the vpc offering.",
- "type": "string"
- },
- {
- "name": "state",
- "description": "state of the vpc offering. Can be Disabled/Enabled",
- "type": "string"
- },
- {
- "name": "isdefault",
- "description": "true if vpc offering is default, false otherwise",
- "type": "boolean"
- },
- {
-
- },
- {
- "name": "name",
- "description": "the name of the vpc offering",
- "type": "string"
- },
- {
- "name": "distributedvpcrouter",
- "description": " indicates if the vpc offering supports distributed router for one-hop forwarding",
- "type": "boolean"
- }
- ]
+ "description": "the total number of networks available to be created for this account",
+ "name": "networkavailable",
+ "type": "string"
},
{
- "name": "uploadVolume",
- "description": "Uploads a data disk.",
- "isasync": true,
- "related": "attachVolume,updateVolume,createVolume,createVolume,listVolumes,resizeVolume,detachVolume,listVolumes,migrateVolume,updateVolume,resizeVolume,migrateVolume,attachVolume,uploadVolume,detachVolume",
- "params": [
- {
- "name": "url",
- "description": "the URL of where the volume is hosted. Possible URL include http:// and https://",
- "type": "string",
- "length": 2048,
- "required": true
- },
- {
- "name": "imagestoreuuid",
- "description": "Image store uuid",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "account",
- "description": "an optional accountName. Must be used with domainId.",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "zoneid",
- "description": "the ID of the zone the volume is to be hosted on",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "createZone,updateZone,listZones,listZones"
- },
- {
- "name": "projectid",
- "description": "Upload volume for the project",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listProjectAccounts,listProjects,activateProject,createProject,updateProject,suspendProject"
- },
- {
- "name": "diskofferingid",
- "description": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createDiskOffering,listDiskOfferings,updateDiskOffering"
- },
- {
- "name": "name",
- "description": "the name of the volume",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "format",
- "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "domainid",
- "description": "an optional domainId. If the account parameter is used, domainId must also be used.",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listDomains,listDomains,listDomainChildren,updateDomain,createDomain"
- },
- {
- "name": "checksum",
- "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 \"{<algorithm>}\", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or [...]
- "type": "string",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
- "name": "virtualmachineid",
- "description": "id of the virtual machine",
- "type": "string"
- },
- {
- "name": "id",
- "description": "ID of the disk volume",
- "type": "string"
- },
- {
- "name": "serviceofferingdisplaytext",
- "description": "the display text of the service offering for root disk",
- "type": "string"
- },
- {
- "name": "displayvolume",
- "description": "an optional field whether to the display the volume to the end user or not.",
- "type": "boolean"
- },
- {
- "name": "attached",
- "description": "the date the volume was attached to a VM instance",
- "type": "date"
- },
- {
- "name": "templatename",
- "description": "the name of the template for the virtual machine",
- "type": "string"
- },
- {
- "name": "snapshotid",
- "description": "ID of the snapshot from which this volume was created",
- "type": "string"
- },
- {
- "name": "vmdisplayname",
- "description": "display name of the virtual machine",
- "type": "string"
- },
- {
- "name": "diskIopsReadRate",
- "description": "io requests read rate of the disk volume",
- "type": "long"
- },
- {
- "name": "diskBytesWriteRate",
- "description": "bytes write rate of the disk volume",
- "type": "long"
- },
- {
- "name": "deviceid",
- "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.",
- "type": "long"
- },
- {
- "name": "podid",
- "description": "pod id of the volume",
- "type": "string"
- },
- {
- "name": "diskofferingid",
- "description": "ID of the disk offering",
- "type": "string"
- },
- {
- "name": "zoneid",
- "description": "ID of the availability zone",
- "type": "string"
- },
- {
- "name": "path",
- "description": "the path of the volume",
- "type": "string"
- },
- {
- "name": "vmname",
- "description": "name of the virtual machine",
- "type": "string"
- },
- {
-
- },
- {
- "name": "status",
- "description": "the status of the volume",
- "type": "string"
- },
- {
- "name": "chaininfo",
- "description": "the chain info of the volume",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the disk volume",
- "type": "string"
- },
- {
- "name": "clusterid",
- "description": "cluster id of the volume",
- "type": "string"
- },
- {
- "name": "storage",
- "description": "name of the primary storage hosting the disk volume",
- "type": "string"
- },
- {
- "name": "serviceofferingid",
- "description": "ID of the service offering for root disk",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the disk volume",
- "type": "string"
- },
- {
- "name": "isextractable",
- "description": "true if the volume is extractable, false otherwise",
- "type": "boolean"
- },
- {
- "name": "vmstate",
- "description": "state of the virtual machine",
- "type": "string"
- },
- {
- "name": "maxiops",
- "description": "max iops of the disk volume",
- "type": "long"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated",
- "type": "set",
- "response": [
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- },
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- }
- ]
- },
- {
- "name": "domain",
- "description": "the domain associated with the disk volume",
- "type": "string"
- },
- {
- "name": "quiescevm",
- "description": "need quiesce vm or not when taking snapshot",
- "type": "boolean"
- },
- {
-
- },
- {
- "name": "provisioningtype",
- "description": "provisioning type used to create volumes.",
- "type": "string"
- },
- {
- "name": "templatedisplaytext",
- "description": " an alternate display text of the template for the virtual machine",
- "type": "string"
- },
- {
- "name": "clustername",
- "description": "cluster name where the volume is allocated",
- "type": "string"
- },
- {
- "name": "diskofferingname",
- "description": "name of the disk offering",
- "type": "string"
- },
- {
- "name": "storageid",
- "description": "id of the primary storage hosting the disk volume; returned to admin user only",
- "type": "string"
- },
- {
- "name": "size",
- "description": "size of the disk volume",
- "type": "long"
- },
- {
- "name": "isodisplaytext",
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "type": "string"
- },
- {
- "name": "miniops",
- "description": "min iops of the disk volume",
- "type": "long"
- },
- {
- "name": "diskIopsWriteRate",
- "description": "io requests write rate of the disk volume",
- "type": "long"
- },
- {
- "name": "utilization",
- "description": "the disk utilization",
- "type": "string"
- },
- {
- "name": "physicalsize",
- "description": "the bytes alloaated",
- "type": "long"
- },
- {
- "name": "diskofferingdisplaytext",
- "description": "the display text of the disk offering",
- "type": "string"
- },
- {
- "name": "storagetype",
- "description": "shared or local storage",
- "type": "string"
- },
- {
- "name": "destroyed",
- "description": "the boolean state of whether the volume is destroyed or not",
- "type": "boolean"
- },
- {
- "name": "diskBytesReadRate",
- "description": "bytes read rate of the disk volume",
- "type": "long"
- },
- {
- "name": "virtualsize",
- "description": "the bytes actually consumed on disk",
- "type": "long"
- },
- {
- "name": "isoname",
- "description": "the name of the ISO attached to the virtual machine",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id of the vpn",
- "type": "string"
- },
- {
- "name": "name",
- "description": "name of the disk volume",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "podname",
- "description": "pod name of the volume",
- "type": "string"
- },
- {
- "name": "isoid",
- "description": "the ID of the ISO attached to the virtual machine",
- "type": "string"
- },
- {
- "name": "state",
- "description": "the state of the disk volume",
- "type": "string"
- },
- {
- "name": "type",
- "description": "type of the disk volume (ROOT or DATADISK)",
- "type": "string"
- },
- {
- "name": "zonename",
- "description": "name of the availability zone",
- "type": "string"
- },
- {
- "name": "templateid",
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name of the vpn",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "created",
- "description": "the date the disk volume was created",
- "type": "date"
- },
- {
- "name": "hypervisor",
- "description": "Hypervisor the volume belongs to",
- "type": "string"
- },
- {
- "name": "serviceofferingname",
- "description": "name of the service offering for root disk",
- "type": "string"
- }
- ]
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
},
{
- "name": "listSecurityGroups",
- "description": "Lists security groups",
- "isasync": false,
- "related": "createSecurityGroup",
- "params": [
- {
- "name": "domainid",
- "description": "list only resources belonging to the domain specified",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listDomains,listDomains,listDomainChildren,updateDomain,createDomain"
- },
- {
- "name": "isrecursive",
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "page",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "virtualmachineid",
- "description": "lists security groups by virtual machine id",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "destroyVirtualMachine,migrateVirtualMachineWithVolume,attachIso,startVirtualMachine,removeNicFromVirtualMachine,updateVirtualMachine,updateVmNicIp,detachIso,rebootVirtualMachine,updateVMAffinityGroup,stopVirtualMachine,detachIso,removeNicFromVirtualMachine,listVirtualMachines,listVirtualMachines,destroyVirtualMachine,attachIso,resetSSHKeyForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,updateDefaultNicForVirtualMachine,assignVirtualMachine,change [...]
- },
- {
- "name": "tags",
- "description": "List resources by tags (key/value pairs)",
- "type": "map",
- "length": 255,
- "required": false
- },
- {
- "name": "account",
- "description": "list resources by account. Must be used with the domainId parameter.",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "pagesize",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "securitygroupname",
- "description": "lists security groups by name",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "keyword",
- "description": "List by keyword",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "id",
- "description": "list the security group by the id provided",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "createSecurityGroup,listSecurityGroups"
- },
- {
- "name": "listall",
- "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",
- "type": "boolean",
- "length": 255,
- "required": false
- },
- {
- "name": "projectid",
- "description": "list objects by project",
- "type": "uuid",
- "length": 255,
- "required": false,
- "related": "listProjectAccounts,listProjects,activateProject,createProject,updateProject,suspendProject"
- }
- ],
- "response": [
- {
- "name": "id",
- "description": "the ID of the security group",
- "type": "string"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated with the rule",
- "type": "set",
- "response": [
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- },
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- }
- ]
- },
- {
- "name": "ingressrule",
- "description": "the list of ingress rules associated with the security group",
- "type": "set",
- "response": [
- {
- "name": "securitygroupname",
- "description": "security group name",
- "type": "string"
- },
- {
- "name": "cidr",
- "description": "the CIDR notation for the base IP address of the security group rule",
- "type": "string"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated with the rule",
- "type": "set",
- "response": [
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- },
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- },
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- }
- ]
- },
- {
- "name": "icmptype",
- "description": "the type of the ICMP message response",
- "type": "integer"
- },
- {
- "name": "protocol",
- "description": "the protocol of the security group rule",
- "type": "string"
- },
- {
- "name": "startport",
- "description": "the starting IP of the security group rule",
- "type": "integer"
- },
- {
- "name": "account",
- "description": "account owning the security group rule",
- "type": "string"
- },
- {
- "name": "ruleid",
- "description": "the id of the security group rule",
- "type": "string"
- },
- {
- "name": "icmpcode",
- "description": "the code for the ICMP message response",
- "type": "integer"
- },
- {
- "name": "endport",
- "description": "the ending IP of the security group rule ",
- "type": "integer"
- }
- ]
- },
- {
- "name": "project",
- "description": "the project name of the group",
- "type": "string"
- },
- {
- "name": "virtualmachinecount",
- "description": "the number of virtualmachines associated with this securitygroup",
- "type": "integer"
- },
- {
- "name": "domain",
- "description": "the domain name of the security group",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "virtualmachineids",
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "type": "set"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id of the group",
- "type": "string"
- },
- {
-
- },
- {
-
- },
- {
- "name": "domainid",
- "description": "the domain ID of the security group",
- "type": "string"
- },
- {
- "name": "description",
- "description": "the description of the security group",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account owning the security group",
- "type": "string"
- },
- {
- "name": "egressrule",
- "description": "the list of egress rules associated with the security group",
- "type": "set",
- "response": [
- {
- "name": "protocol",
- "description": "the protocol of the security group rule",
- "type": "string"
- },
- {
- "name": "icmptype",
- "description": "the type of the ICMP message response",
- "type": "integer"
- },
- {
- "name": "account",
- "description": "account owning the security group rule",
- "type": "string"
- },
- {
- "name": "endport",
- "description": "the ending IP of the security group rule ",
- "type": "integer"
- },
- {
- "name": "securitygroupname",
- "description": "security group name",
- "type": "string"
- },
- {
- "name": "tags",
- "description": "the list of resource tags associated with the rule",
- "type": "set",
- "response": [
- {
- "name": "resourceid",
- "description": "id of the resource",
- "type": "string"
- },
- {
- "name": "account",
- "description": "the account associated with the tag",
- "type": "string"
- },
- {
- "name": "resourcetype",
- "description": "resource type",
- "type": "string"
- },
- {
- "name": "domain",
- "description": "the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain associated with the tag",
- "type": "string"
- },
- {
- "name": "key",
- "description": "tag key name",
- "type": "string"
- },
- {
- "name": "projectid",
- "description": "the project id the tag belongs to",
- "type": "string"
- },
- {
- "name": "project",
- "description": "the project name where tag belongs to",
- "type": "string"
- },
- {
- "name": "value",
- "description": "tag value",
- "type": "string"
- },
- {
- "name": "customer",
- "description": "customer associated with the tag",
- "type": "string"
- }
- ]
- },
- {
- "name": "icmpcode",
- "description": "the code for the ICMP message response",
- "type": "integer"
- },
- {
- "name": "startport",
- "description": "the starting IP of the security group rule",
- "type": "integer"
- },
- {
- "name": "ruleid",
- "description": "the id of the security group rule",
- "type": "string"
- },
- {
- "name": "cidr",
- "description": "the CIDR notation for the base IP address of the security group rule",
- "type": "string"
- }
- ]
- },
- {
- "name": "name",
- "description": "the name of the security group",
- "type": "string"
- }
- ]
+ "description": "true if account is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
},
{
- "name": "configureOutOfBandManagement",
- "description": "Configures a host's out-of-band management interface",
- "since": "4.9.0",
- "isasync": false,
- "related": "disableOutOfBandManagementForHost,enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,disableOutOfBandManagementForZone,enableOutOfBandManagementForCluster,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword",
- "params": [
- {
- "name": "port",
- "description": "the host management interface port",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "driver",
- "description": "the host management interface driver, for example: ipmitool",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "address",
- "description": "the host management interface IP address",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "username",
- "description": "the host management interface user",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "password",
- "description": "the host management interface password",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "hostid",
- "description": "the ID of the host",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "prepareHostForMaintenance,cancelHostMaintenance,addHost,reconnectHost,addBaremetalHost"
- }
- ],
- "response": [
- {
-
- },
- {
-
- },
- {
- "name": "address",
- "description": "the out-of-band management interface address",
- "type": "string"
- },
- {
- "name": "password",
- "description": "the out-of-band management interface password",
- "type": "string"
- },
- {
- "name": "port",
- "description": "the out-of-band management interface port",
- "type": "string"
- },
- {
- "name": "enabled",
- "description": "true if out-of-band management is enabled for the host",
- "type": "boolean"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "powerstate",
- "description": "the out-of-band management interface powerState of the host",
- "type": "powerstate"
- },
- {
- "name": "status",
- "description": "the operation result",
- "type": "boolean"
- },
- {
- "name": "description",
- "description": "the operation result description",
- "type": "string"
- },
- {
- "name": "action",
- "description": "the out-of-band management action (if issued)",
- "type": "string"
- },
- {
- "name": "username",
- "description": "the out-of-band management interface username",
- "type": "string"
- },
- {
- "name": "driver",
- "description": "the out-of-band management driver for the host",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "hostid",
- "description": "the ID of the host",
- "type": "string"
- }
- ]
+ "description": "the name of the account",
+ "name": "name",
+ "type": "string"
},
{
- "name": "listStorageTags",
- "description": "Lists storage tags",
- "isasync": false,
- "related": "",
- "params": [
- {
- "name": "pagesize",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "keyword",
- "description": "List by keyword",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "page",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
- "name": "id",
- "description": "the ID of the storage tag",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
-
- },
- {
- "name": "name",
- "description": "the name of the storage tag",
- "type": "string"
- },
- {
- "name": "poolid",
- "description": "the pool ID of the storage tag",
- "type": "long"
- },
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- }
- ]
+ "description": "the total secondary storage space (in GiB) available to be used for this account",
+ "name": "secondarystorageavailable",
+ "type": "string"
},
{
- "name": "deleteServicePackageOffering",
- "description": "Delete Service Package",
- "isasync": false,
- "params": [
- {
- "name": "id",
- "description": "the service offering ID",
- "type": "string",
- "length": 255,
- "required": true,
- "related": "registerNetscalerServicePackage,listRegisteredServicePackages"
- }
- ],
- "response": [
- {
-
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
-
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- }
- ]
+ "description": "the total number of templates which have been created by this account",
+ "name": "templatetotal",
+ "type": "long"
},
{
- "name": "listTemplatePermissions",
- "description": "List template visibility and all accounts that have permissions to view this template.",
- "isasync": false,
- "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions",
- "params": [
- {
- "name": "id",
- "description": "the template ID",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "listTemplatePermissions,listIsoPermissions,listTemplatePermissions,listIsoPermissions"
- }
- ],
- "response": [
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the template ID",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "account",
- "description": "the list of accounts the template is available for",
- "type": "list"
- },
- {
- "name": "domainid",
- "description": "the ID of the domain to which the template belongs",
- "type": "string"
- },
- {
- "name": "projectids",
- "description": "the list of projects the template is available for",
- "type": "list"
- },
- {
-
- },
- {
-
- },
- {
- "name": "ispublic",
- "description": "true if this template is a public template, false otherwise",
- "type": "boolean"
- }
- ]
+ "description": "the id of the account",
+ "name": "id",
+ "type": "string"
},
{
- "name": "destroySystemVm",
- "description": "Destroyes a system virtual machine.",
- "isasync": true,
- "related": "stopSystemVm,migrateSystemVm,changeServiceForSystemVm,startSystemVm,listSystemVms,scaleSystemVm",
- "params": [
- {
- "name": "id",
- "description": "The ID of the system virtual machine",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "stopSystemVm,migrateSystemVm,changeServiceForSystemVm,startSystemVm,destroySystemVm,listSystemVms,scaleSystemVm"
- }
- ],
- "response": [
- {
- "name": "privatenetmask",
- "description": "the private netmask for the system VM",
- "type": "string"
- },
- {
- "name": "publicmacaddress",
- "description": "the public MAC address for the system VM",
- "type": "string"
- },
- {
- "name": "linklocalip",
- "description": "the link local IP address for the system vm",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "activeviewersessions",
- "description": "the number of active console sessions for the console proxy system vm",
- "type": "integer"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "linklocalmacaddress",
- "description": "the link local MAC address for the system vm",
- "type": "string"
- },
- {
-
- },
- {
- "name": "state",
- "description": "the state of the system VM",
- "type": "string"
- },
- {
- "name": "templateid",
- "description": "the template ID for the system VM",
- "type": "string"
- },
- {
- "name": "podid",
- "description": "the Pod ID for the system VM",
- "type": "string"
- },
- {
- "name": "created",
- "description": "the date and time the system VM was created",
- "type": "date"
- },
- {
- "name": "networkdomain",
- "description": "the network domain for the system VM",
- "type": "string"
- },
- {
- "name": "privatemacaddress",
- "description": "the private MAC address for the system VM",
- "type": "string"
- },
- {
- "name": "dns2",
- "description": "the second DNS for the system VM",
- "type": "string"
- },
- {
- "name": "dns1",
- "description": "the first DNS for the system VM",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "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.",
- "type": "integer"
- },
- {
- "name": "jobid",
- "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.",
- "type": "string"
- },
- {
- "name": "zoneid",
- "description": "the Zone ID for the system VM",
- "type": "string"
- },
- {
- "name": "gateway",
- "description": "the gateway for the system VM",
- "type": "string"
- },
- {
- "name": "linklocalnetmask",
- "description": "the link local netmask for the system vm",
- "type": "string"
- },
- {
- "name": "publicip",
- "description": "the public IP address for the system VM",
- "type": "string"
- },
- {
- "name": "hostid",
- "description": "the host ID for the system VM",
- "type": "string"
- },
- {
- "name": "zonename",
- "description": "the Zone name for the system VM",
- "type": "string"
- },
- {
- "name": "publicvlan",
- "description": "public vlan range",
- "type": "list"
- },
- {
-
- },
- {
- "name": "id",
- "description": "the ID of the system VM",
- "type": "string"
- },
- {
- "name": "systemvmtype",
- "description": "the system VM type",
- "type": "string"
- },
- {
- "name": "privateip",
- "description": "the private IP address for the system VM",
- "type": "string"
- },
- {
- "name": "name",
- "description": "the name of the system VM",
- "type": "string"
- },
- {
- "name": "hypervisor",
- "description": "the hypervisor on which the template runs",
- "type": "string"
- },
- {
- "name": "hostname",
- "description": "the hostname for the system VM",
- "type": "string"
- },
- {
- "name": "guestvlan",
- "description": "guest vlan range",
- "type": "string"
- },
- {
- "name": "publicnetmask",
- "description": "the public netmask for the system VM",
- "type": "string"
- }
- ]
+ "description": "the total number of virtual machines that can be deployed by this account",
+ "name": "vmlimit",
+ "type": "string"
},
{
- "name": "listAnnotations",
- "description": "Lists annotations.",
- "since": "4.11",
- "isasync": false,
- "related": "removeAnnotation,addAnnotation",
- "params": [
- {
- "name": "entitytype",
- "description": "the entity type",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "page",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "id",
- "description": "the id of the annotation",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "entityid",
- "description": "the id of the entity for which to show annotations",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "pagesize",
- "description": "",
- "type": "integer",
- "length": 255,
- "required": false
- },
- {
- "name": "keyword",
- "description": "List by keyword",
- "type": "string",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
- "name": "userid",
- "description": "The (uu)id of the user that entered the annotation",
- "type": "string"
- },
- {
-
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "entityid",
- "description": "the (uu)id of the entitiy to which this annotation pertains",
- "type": "string"
- },
- {
- "name": "created",
- "description": "the creation timestamp for this annotation",
- "type": "date"
- },
- {
- "name": "removed",
- "description": "the removal timestamp for this annotation",
- "type": "date"
- },
- {
-
- },
- {
- "name": "annotation",
- "description": "the contents of the annotation",
- "type": "string"
- },
- {
- "name": "id",
- "description": "the (uu)id of the annotation",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "entitytype",
- "description": "the type of the annotated entity",
- "type": "string"
- }
- ]
+ "description": "the total primary storage space (in GiB) the account can own",
+ "name": "primarystoragelimit",
+ "type": "string"
},
+ {},
{
- "name": "addSwift",
- "description": "Adds Swift.",
- "since": "3.0.0",
- "isasync": false,
- "related": "listImageStores,createSecondaryStagingStore,addSecondaryStorage,updateCloudToUseObjectStore,addImageStore,listSwifts,listSecondaryStagingStores,addImageStoreS3",
- "params": [
- {
- "name": "url",
- "description": "the URL for swift",
- "type": "string",
- "length": 255,
- "required": true
- },
- {
- "name": "account",
- "description": "the account for swift",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "key",
- "description": " key for the user for swift",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "username",
- "description": "the username for swift",
- "type": "string",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
-
- },
- {
- "name": "url",
- "description": "the url of the image store",
- "type": "string"
- },
- {
- "name": "zoneid",
- "description": "the Zone ID of the image store",
- "type": "string"
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "zonename",
- "description": "the Zone name of the image store",
- "type": "string"
- },
- {
- "name": "scope",
- "description": "the scope of the image store",
- "type": "scopetype"
- },
- {
- "name": "id",
- "description": "the ID of the image store",
- "type": "string"
- },
- {
- "name": "protocol",
- "description": "the protocol of the image store",
- "type": "string"
- },
- {
- "name": "providername",
- "description": "the provider name of the image store",
- "type": "string"
- },
- {
-
- },
- {
- "name": "name",
- "description": "the name of the image store",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- }
- ]
+ "description": "the total number of virtual machines running for this account",
+ "name": "vmrunning",
+ "type": "integer"
},
{
- "name": "archiveEvents",
- "description": "Archive one or more events.",
- "isasync": false,
- "params": [
- {
- "name": "ids",
- "description": "the IDs of the events",
- "type": "list",
- "length": 255,
- "required": false,
- "related": "listEvents"
- },
- {
- "name": "startdate",
- "description": "start date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
- "type": "date",
- "length": 255,
- "required": false
- },
- {
- "name": "type",
- "description": "archive by event type",
- "type": "string",
- "length": 255,
- "required": false
- },
- {
- "name": "enddate",
- "description": "end date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
- "type": "date",
- "length": 255,
- "required": false
- }
- ],
- "response": [
- {
-
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
- "type": "integer"
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- },
- {
-
- },
- {
- "name": "success",
- "description": "true if operation is executed successfully",
- "type": "boolean"
- }
- ]
+ "description": "the total number of networks owned by account",
+ "name": "networktotal",
+ "type": "long"
},
{
- "name": "deleteSecondaryStagingStore",
- "description": "Deletes a secondary staging store .",
- "since": "4.2.0",
- "isasync": false,
- "params": [
- {
- "name": "id",
- "description": "the staging store ID",
- "type": "uuid",
- "length": 255,
- "required": true,
- "related": "listImageStores,createSecondaryStagingStore,addSecondaryStorage,updateCloudToUseObjectStore,addImageStore,listSwifts,listSecondaryStagingStores,addImageStoreS3"
- }
- ],
- "response": [
- {
-
- },
- {
- "name": "displaytext",
- "description": "any text associated with the success or failure",
- "type": "string"
- },
- {
-
- },
- {
- "name": "jobid",
- "description": "the UUID of the latest async job acting on this object",
- "type": "string"
- },
- {
- "name": "jobstatus",
- "description": "the current status of the latest async job acting on this object",
... 213893 lines suppressed ...